1、 概述
Content-Type:application/json
appid:待定 (对应client_id)
secret:待定 (对应client_secret)
hc:待定 (对应店铺ID)
{"statusCode":200, "data":{}, "ext": {"s":"u13d226fd61"}}
{"statusCode":400, "msg":"参数错误", "errors":"参数错误"}
PHP示例:
$data = [
'timestamp' => time(),
'appid' => 'abcabc',
'hc' => 'abcabc'
];
ksort($data);
$signString = '';
foreach ($data as $k => $v) {
$signString .= $k . $v;
}
$secret = 'abcdabcd';
$sgin = strtoupper(sha1(md5($signString . $secret)));
JAVA示例:
String appid = "appid";
String hc = "hc";
String secret = "secret";
long timestamp = System.currentTimeMillis() / 1000;
Map<String, Object> map = new HashMap<>();
map.put("timestamp", timestamp);
map.put("appid", appid);
map.put("hc", hc);
TreeMap<String, Object> sortMap = new TreeMap<>(map);
StringBuilder stringBuilder = new StringBuilder();
for (Map.Entry<String, Object> entry : sortMap.entrySet()) {
stringBuilder.append(entry.getKey()).append(entry.getValue());
}
String md5 = MD5(stringBuilder.toString() + secret);
String sign = SHA1(md5.getBytes()).toUpperCase();
public static String SHA1(byte[] input) throws Exception {
MessageDigest mDigest;
mDigest = MessageDigest.getInstance("SHA1");
byte[] result = mDigest.digest(input);
StringBuilder sb = new StringBuilder();
for (byte b : result) {
sb.append(Integer.toString((b & 0xff) + 0x100, 16).substring(1));
}
return sb.toString();
}
public static String MD5(String data) throws Exception {
java.security.MessageDigest md = MessageDigest.getInstance("MD5");
byte[] array = md.digest(data.getBytes("UTF-8"));
StringBuilder sb = new StringBuilder();
for (byte item : array) {
sb.append(Integer.toHexString((item & 0xFF) | 0x100).substring(1, 3));
}
return sb.toString();
}
$localSign = "123";
$signature = $_POST["signature"];
$timestamp = $_POST["timestamp"];
$sign = sha1(md5($localSign . $timestamp));
if ($signature == $sign) {
echo "success";
} else {
echo "error";
}
Path: /api/openplatform/members/userLearnCourseList
Method: POST
接口描述:
userId、mobile、unionId至少必须传递一个值
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
userId | 否 | 用户id | |
mobile | 否 | 手机号 | |
unionId | 否 | 用户的unionId | |
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 | ||
limit | 否 | 每页条数,默认值为20 | |
page | 是 | 第几页 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | object | 必须 | |||
├─ list | object [] | 必须 | item 类型: object | ||
├─ pName | string | 必须 | 课程名称 | ||
├─ pType | integer | 必须 | 课程类型 1: 'VIP', 2: 'VIP', 3: 'VIP2', 4: 'svip', 5: '课程', 6: '分类', 7: '活动付费', 8: '资料购买', 9: '专栏', 10: '社群购买', 11: '购买测评', 12: '商城购买', 13: '独立商城', 15: '问答提问', 16: '问答提问', 17: '问答围观', 18: '问答退款', 20: '余额利息', 22: '购买VIP2', 23: '购买SVIP', 24: '赠送专栏', 25: '买赠课程', 26: '买赠专栏', 27: '买赠VIP', 28: '买赠SVIP', 29: '拼团专栏', 30: '拼团课程', 31: '拼团VIP', 32: '拼团SVIP', 33: '社群打赏', 35: '直播打赏', 36: '拼团活动', 37: '课程', 38: '专栏兑换码', 39: 'vip兑换码', 40: 'svip兑换码', 41: '购买打卡课程', 42: '升级代理商', 43: '升级合伙人', 44: '升级分公司', 45: '兑换知识套餐', 46: '打卡退款', 47: '购买短信', 48: '拼团知识套餐', 61: '购买知识套餐', 62: '买赠知识套餐', 50: '购买流量套餐', 51: '公开课', 52: '活动签到退款', 53: '购买约课', 54: '约课签到退款', 56: '购买词典', 57: '购买下载流量', 59: '功能购买', 66: '限时购课程', 67: '限时购专栏', 68: '限时购VIP', 69: '限时购svip', 70: '限时购知识套餐', 71: '限时购测评', 72: '限时购直播', 73: '买赠限时购VIP', 74: '买赠限时购SVIP', 75: '互动测评', 77: 'AI.测评', 78: '购买训练营', 79: '返奖金训练营', 80: '打卡返奖金', 81: '打卡返奖金', 86: '预约', 87: '预约退款', 88: '商城退款', 93: '系统续费', 97: '约课复训交费', 98: '约课退复训费用', 100: 'IOS充值', 103: '产品推广', 104: '拼团推广', 115: '小班直播', 116: '面授课', 120: '商品退款', 125: '考试', 111: '音频', 112: '图文', 110: '视频', 124: '拼团直播', 127: '交易失败回退', 129: '练习', 130: '投票', 138: '升级运营中心', // 五级服务商 139: '升级总代', // 五级服务商 142: '电子书', 144: '电子书兑换码', 145: '买赠电子书', 146: '买赠训练营', 160: '升级六级经销商', 161: '升级七级经销商', 162: '升级八级经销商', 163: '升级九级经销商', 178: '投票赠礼', 180: '直播间', 181: '圈子', 185: '圈子主题', 183: '股东升级', 187: '席位费', 188: '席位费退款', 200: '代金券', 300: '在线编辑图片', 186: '席位费', 190: '虚拟币充值', 400: '子店铺账号', 1000: '购买素材空间', 2000: '高清转码费', 2048: '幸运大转盘', 4096: '砍价购课程', 1515: '预约专区', 1717: '预约围观', | ||
├─ permissionType | integer | 必须 | 权限类型1: '普通订单', 2: '拼团', 4: '买赠', 8: '限时购', 12: '买赠', 16: '好友助力', 32: '兑换码', 64: '系统赠送', 128: '涨粉神器', 256: '亲情卡', 512: '普通订单', 1024: '积分商城', 2048: '大转盘', 4096: '砍价', 8192: '支付有礼', 16384: '直播抽奖', 32768: '直播福利', 262144: '股东赠送', 131072: '邀请活动奖励', 524288: '实物带货', 2097152: '企业团购', 4194304: '推荐有礼', 65536: '普通订单', 66048: '普通订单', 8388608: '礼包赠送', 134217728: '搭配购', 16777216: '圈子任务' | ||
├─ hasPermission | boolean | 必须 | 权限状态 true正常,false失效 | ||
├─ learningTimes | string | 必须 | 学习时间 | ||
├─ progressRatio | integer | 必须 | 学习进度 | ||
├─ startLearningTime | string,null | 必须 | 首次加入时间 | ||
├─ recentLearnTime | string,null | 必须 | 最近学习时间 | ||
├─ cplTime | null | 必须 | 完成时间 | ||
├─ expireAt | string,null | 必须 | 有效期,null为长期有效 | ||
├─ total | integer | 必须 |
Path: /api/openplatform/members/saveUsers
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
userList | string | 必须 | json格式 | mock: [{"mobile":"用户手机号,没有值传空","customerUserId":"中和应泰平台用户id,没有值传0","nickname":"昵称","headimgurl":"用户头像地址","unionid":"唯一标识,没有值传空"}] |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/members/getAreaList
Method: POST
接口描述:
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
appid | 是 | ||
timestamp | 是 | ||
hc | 是 | ||
sign | 是 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | object | 必须 | |||
├─ data | object [] | 必须 | item 类型: object | ||
├─ name | string | 非必须 | 名称 | ||
├─ level | integer | 非必须 | 地区深度(等级),从1开始 | ||
├─ value | string | 非必须 | 地区id | ||
├─ parent | string | 非必须 | 父级id |
Path: /api/openplatform/members/saveUserAddress
Method: POST
接口描述:
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
mobile | 否 | 手机号 | |
unionId | 否 | 用户的unionId | |
userId | 否 | 用户id | |
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 | ||
addrId | 否 | 收地址id,新建为0 | |
name | 是 | 收货人 | |
addressMobile | 是 | 收货人电话 | |
provinceId | 是 | 省份id | |
cityId | 是 | 市id | |
areaId | 是 | 区域id | |
address | 是 | 详细地址 | |
status | 否 | 1:默认地址;2:普通地址;-1: 已删除 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | string | 必须 |
Path: /api/openplatform/members/memberBusiness
Method: POST
接口描述:
userId、mobile、unionId至少必须传递一个值
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
userId | 否 | 用户id | |
mobile | 否 | 手机号 | |
unionId | 否 | 用户的unionId | |
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | object | 必须 | |||
├─ consumedMoney | string | 必须 | 总消费金额(元) | ||
├─ consumeNumber | integer | 必须 | 消费次数 | ||
├─ backTime | integer | 必须 | 退款订单数 | ||
├─ backMoney | number | 必须 | 累计退款金额(元) | ||
├─ consumeTime | string | 必须 | 最近消费时间 |
Path: /api/openplatform/members/memberInfo
Method: POST
接口描述:
userId、mobile、unionId至少必须传递一个值
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
mobile | 否 | ||
unionId | 否 | ||
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | object | 必须 | |||
├─ refereeNickname | string | 必须 | 推荐人昵称 | ||
├─ refereeHeadimgurl | string | 必须 | 推荐人头像 | ||
├─ refereeUserId | string | 必须 | 推荐人Id | ||
├─ userId | string | 必须 | 用户Id | ||
├─ nickname | string | 必须 | 昵称 | ||
├─ headimgurl | string | 必须 | 头像 | ||
├─ realName | string | 必须 | 真名 | ||
├─ mobile | string | 必须 | 手机号 | ||
├─ gender | integer | 必须 | 性别0未知 1男 2女 | ||
├─ vipType | integer | 必须 | 用户身份 | ||
├─ fromChannel | integer | 必须 | 用户来源:-1=未知; 1=mp 公众号; 2=wxapp 小程序; 3=android; 4=ios; 5=web/pc; 10=抖音;13=手机号注册;14=抖音;20=手动导入;127=手机号注册; | ||
├─ vipStartTime | string | 必须 | VIP有效期开始时间 | ||
├─ vipEndTime | string | 必须 | VIP到期时间 | ||
├─ svipStartTime | string | 必须 | SVIP有效期开始时间 | ||
├─ svipEndTime | string | 必须 | SVIP有效期结束时间 | ||
├─ balance | string | 必须 | 账户金额 | ||
├─ totalIncome | string | 必须 | 累计收入 | ||
├─ points | string | 必须 | 积分 | ||
├─ activeTime | string | 必须 | 最近活跃时间 | ||
├─ setAreaAgentTime | string | 必须 | 加入代理时间 | ||
├─ createdAt | string | 必须 | 注册时间 | ||
├─ bindMobileAt | string | 必须 | 绑定手机号时间 | ||
├─ provinceName | string | 必须 | 省份 | ||
├─ cityName | string | 必须 | 市 | ||
├─ areaName | string | 必须 | 区 | ||
├─ vipTypeName | string | 必须 | 身份类型名称 | ||
├─ identityInformation | object | 必须 | 身份信息 | ||
├─ auditAt | string | 必须 | 加入服务商时间 | ||
├─ areaAgentList | object [] | 必须 | 区域代理 | item 类型: object | |
├─ addAt | string | 必须 | 加入代理时间 | ||
├─ areaLevel | integer | 必须 | |||
├─ province_city_area | string | 必须 | 代理的区域 | ||
├─ auditTime | string | 必须 | |||
├─ shareholdersType | string | 必须 | 股东属性 | ||
├─ addAt | string | 必须 | 加入股东时间 | ||
├─ apply | string | 必须 | 服务商属性 | ||
├─ followedMp | integer | 必须 | 是否关注公众号 1关注 0未关注 |
Path: /api/openplatform/members/userList
Method: POST
接口描述:
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
mobile | 否 | 用户手机号 | |
userId | 否 | 用户id | |
nickname | 否 | 用户昵称 | |
reNickname | 否 | 推荐人昵称 | |
reMobile | 否 | 推荐人手机号 | |
reUserId | 否 | 推荐人id | |
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | object | 必须 | |||
├─ data | object [] | 必须 | item 类型: object | ||
├─ nickname | string | 必须 | 昵称 | ||
├─ realName | string,null | 必须 | 真实姓名 | ||
├─ userId | string | 必须 | 用户id | ||
├─ reUserId | string | 必须 | 推荐人id | ||
├─ mobile | string | 必须 | 手机号 | ||
├─ createdAt | string | 必须 | 注册时间 | ||
├─ vipType | integer | 必须 | 用户身份1-普通会员 2-VIP 3-代理商 4-SVIP 5-合伙人,6-分公司,7运营中心,8总代, 9 agent6, 10 agent7, 11 agent8, 12 agent9 | ||
├─ fromChannel | integer | 必须 | 来源,1=未知; 1=mp 公众号; 2=wxapp 小程序; 3=android; 4=ios; 5=web/pc; 10=抖音;13=手机号注册;14=抖音;20=手动导入;127=手机号注册 | ||
├─ reNickname | string | 必须 | 推荐人昵称 | ||
├─ reMobile | string | 必须 | 推荐人手机号 | ||
├─ total | integer | 必须 | 总条数 |
Path: /api/openplatform/members/userRefundList
Method: POST
接口描述:
userId、mobile、unionId至少必须传递一个值
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
mobile | 否 | 手机号 | |
unionId | 否 | 用户的unionId | |
userId | 否 | 用户id | |
startAt | 否 | 搜索开始时间 | |
endAt | 否 | 搜索结束时间 | |
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 | ||
limit | 否 | ||
page | 否 | ||
goodsName | 否 | 产品名称 | |
orderNo | 否 | 订单号 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | object | 必须 | |||
├─ data | object [] | 必须 | item 类型: object | ||
├─ goodsName | string | 必须 | 商品名称 | ||
├─ deliverStatus | integer | 必须 | 是否发货1-未发货,2-已发货 | ||
├─ payMoney | string | 必须 | 订单金额 | ||
├─ refundMoney | string | 必须 | 退款金额 | ||
├─ applyAt | string | 必须 | 申请时间 | ||
├─ overTime | string | 必须 | 超时时间 | ||
├─ refundStatus | integer | 必须 | 售后操作,1:买家申请中 2:商家同意售后4-商家同意退货,5-买家已寄货 -1:用户撤销售后 -2:商家拒绝售后 -3:买家超时未处理 -4:商家自动关闭 -5:商家退款失败关闭 -6:退货拒绝退款 | ||
├─ afterStatus | integer | 必须 | 售后状态,1:售后中 2:售后完成 -1:售后关闭 | ||
├─ adminUser | string | 必须 | 操作者 | ||
├─ orderNo | string | 必须 | 订单号 | ||
├─ total | integer | 必须 | 总条数 |
Path: /api/openplatform/members/myMallOrders
Method: POST
接口描述:
userId、mobile、unionId至少必须传递一个值
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
mobile | 否 | 手机号 | |
unionId | 否 | 用户的unionId | |
userId | 否 | 用户id | |
startAt | 否 | 搜索开始时间 | |
endAt | 否 | 搜索结束时间 | |
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 | ||
limit | 否 | ||
page | 否 | ||
goodsName | 否 | 产品名称 | |
orderNo | 否 | 订单号 | |
status | 否 | 订单状态, 全部:'',待付款:0,待发货:1,已发货:2,已完成:3,已关闭:4,退款/售后:5 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | object | 必须 | |||
├─ data | object [] | 必须 | item 类型: object | ||
├─ orderNo | string | 必须 | 订单号 | ||
├─ goId | integer | 必须 | 订单id | ||
├─ createdAt | string | 必须 | 创建时间 | ||
├─ status | string | 必须 | 状态 | ||
├─ payAt | string,null | 必须 | 支付时间 | ||
├─ payMoney | string | 必须 | 支付金额 | ||
├─ orderDetail | object [] | 必须 | 订单明细 | item 类型: object | |
├─ goodsName | string | 必须 | |||
├─ deliverType | integer | 必须 | |||
├─ postage | string | 必须 | 邮费 | ||
├─ deductedMoney | string | 必须 | 积分抵扣金额 | ||
├─ favourablePrice | string | 必须 | 优惠金额 | ||
├─ cashBackAmount | string | 必须 | 满减金额 | ||
├─ deductedCouponMoney | string | 必须 | 优惠券金额 | ||
├─ type | string | 必须 | 订单类型 | ||
├─ total | integer | 必须 |
Path: /api/openplatform/members/memberLearnDetailList
Method: POST
接口描述:
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
mobile | 否 | 用户手机号 | |
userId | 否 | 用户id | |
nickname | 否 | 用户昵称 | |
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 | ||
start_time | 否 | 开始时间 | |
end_time | 否 | 结束时间 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | object | 必须 | |||
├─ data | object [] | 必须 | item 类型: object | ||
├─ nickname | string | 必须 | 昵称 | ||
├─ realName | string,null | 必须 | 真实姓名 | ||
├─ userId | string | 必须 | 用户id | ||
├─ mobile | string | 必须 | 手机号 | ||
├─ vipType | integer | 必须 | 身份类型1-普通会员 2-VIP 3-代理商 4-SVIP 5-合伙人,6-分公司,7运营中心,8总代, 9 agent6, 10 agent7, 11 agent8, 12 agent9 | ||
├─ fromChannel | integer | 必须 | 来源:-1=未知; 1=mp 公众号; 2=wxapp 小程序; 3=android; 4=ios; 5=web/pc; 10=抖音;13=手机号注册;14=抖音;20=手动导入;127=手机号注册 | ||
├─ reMobile | string | 必须 | 推荐人手机号 | ||
├─ headimgurl | string | 必须 | 头像 | ||
├─ reNickname | string | 必须 | 推荐人昵称 | ||
├─ pVipType | integer | 必须 | 推荐人身份 | ||
├─ totalLearningTime | integer | 必须 | 总学习时间 | ||
├─ totalLearningDay | integer | 必须 | 总学习天师 | ||
├─ totalLearningCount | integer | 必须 | 累计学习课程数 | ||
├─ totalLearningLiveCount | integer | 必须 | 累计学习直播数 | ||
├─ activeTime | string | 必须 | 最近访问时间 | ||
├─ pusherId | string | 必须 | 推荐人id | ||
├─ total | integer | 必须 | 总条数 |
Path: /api/openplatform/members/learningStats
Method: POST
接口描述:
包括:视频、音频、图文、专栏、电子书、训练营
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
userId | 否 | 用户id | |
mobile | 否 | 手机号 | |
unionId | 否 | 用户的unionId | |
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | object | 必须 | |||
├─ totalLearningDay | integer | 必须 | 累计学习天数 | ||
├─ totalLearningCount | integer | 必须 | 学习课程数 | ||
├─ totalLearningLiveCount | integer | 必须 | 累计学习直播(场次) | ||
├─ yesterdayLearningTime | integer | 必须 | 昨日学习时长 | ||
├─ lastMonthLearningTime | integer | 必须 | 上个月学习时长 | ||
├─ totalLearningTime | integer | 必须 | 累计学习时长(学习时长和学习天数统计的课程类型包括:视频、音频、图文、训练营、电子书 、公开课、小班课、直播间;专栏下的课程已单独统计,所以不再重复统计专栏) |
Path: /api/openplatform/members/userAddress
Method: POST
接口描述:
userId、mobile、unionId至少必须传递一个值
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
mobile | 否 | 手机号 | |
unionId | 否 | 用户的unionId | |
userId | 否 | 用户id | |
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 | ||
limit | 否 | ||
page | 否 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | object | 必须 | |||
├─ data | object [] | 必须 | item 类型: object | ||
├─ addressId | integer | 非必须 | 地址id | ||
├─ province | string | 非必须 | 省份 | ||
├─ city | string | 非必须 | 市 | ||
├─ area | string | 非必须 | 区 | ||
├─ mobile | string | 非必须 | 收货手机号 | ||
├─ name | string | 非必须 | 收人人姓名 | ||
├─ address | string | 必须 | 详细地址 | ||
├─ total | integer | 必须 |
Path: /api/openplatform/members/userPointLogList
Method: POST
接口描述:
userId、mobile、unionId至少必须传递一个值
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
mobile | 否 | 手机号 | |
unionId | 否 | 用户的unionId | |
userId | 否 | 用户id | |
create_time | 否 | 搜索开始时间 | |
end_time | 否 | 搜索结束时间 | |
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 | ||
limit | 否 | ||
page | 否 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | object | 必须 | |||
├─ data | object [] | 必须 | item 类型: object | ||
├─ nickname | string | 必须 | 昵称 | ||
├─ userId | string | 必须 | 用户id | ||
├─ mobile | string | 必须 | 手机号 | ||
├─ sNickname | null | 必须 | 来源昵称 | ||
├─ sMobile | null | 必须 | 来源手机号 | ||
├─ sHeadimgurl | null | 必须 | 来源头像 | ||
├─ headimgurl | string | 必须 | 用户头像 | ||
├─ src | integer | 必须 | 类型 | ||
├─ srcName | string | 必须 | 类型说明 | ||
├─ points | integer | 必须 | 积分 | ||
├─ proName | string | 必须 | 来源/用途 | ||
├─ registrantId | string | 必须 | 来源用户id | ||
├─ createdAt | string | 必须 | 创建时间 | ||
├─ total | integer | 必须 | 总条数 |
Path: /api/openplatform/members/userGiftCardLogList
Method: POST
接口描述:
userId、mobile、unionId至少必须传递一个值
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
mobile | 否 | 手机号 | |
unionId | 否 | 用户的unionId | |
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 | ||
userId | 否 | 用户id | |
listType | 否 | 列表数据:0全部 1充值流水 2扣除流水,默认0全部 | |
limit | 否 | 每页条数,默认10 | |
page | 否 | 当前页 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | object | 必须 | |||
├─ data | object [] | 必须 | item 类型: object | ||
├─ userId | string | 必须 | 用户id | ||
├─ nickname | string | 必须 | 昵称 | ||
├─ mobile | string | 必须 | 手机号 | ||
├─ coinNumber | integer | 必须 | 虚拟币流水数量 | ||
├─ typeText | string | 必须 | 类型 | ||
├─ remark | string | 必须 | 备注 | ||
├─ createdAt | string | 必须 | 创建时间 | ||
├─ total | integer | 必须 | 总条数 |
Path: /api/openplatform/members/permissionLog
Method: POST
接口描述:
1、用户当前开通的课程、互动、直播、约课、教务、内容市场的权限记录,不包含会员、问答、直播打赏、预约师资记录
2、userId、mobile、unionId至少必须传递一个值
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
userId | 否 | 用户id | |
mobile | 否 | 手机号 | |
unionId | 否 | 用户的unionId | |
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 | ||
searchName | 否 | 课程名称 | |
startTime | 否 | 搜索开始时间 | |
endTime | 否 | 搜索结束时间 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | object | 必须 | |||
├─ data | object [] | 必须 | item 类型: object | ||
├─ prodType | integer | 必须 | 类型:1: 'VIP', 5: '课程', 7: '活动', 8: '资料', 9: '专栏', 10: '社群', 11: '测评', 15: '问答', 23: 'SVIP', 42: '服务商', 43: '服务商', 44: '服务商', 51: '公开课', 53: '约课', 56: '词典', 41: '打卡', 61: '知识套餐', 75: '互动测评', 77: 'AI测评', 78: '训练营', 86: '预约', 103: '内容专栏', 115: '小班直播', 116: '教务系统', 125: '考试', 129: '练习', 142: '电子书', 180: '直播间', 181: '圈子', 185: '圈子主题', 187: '约课', 5000: '有价优惠券' | ||
├─ prodId | integer | 必须 | 产品id | ||
├─ prodName | string | 必须 | 产品名称 | ||
├─ avatar | string | 必须 | 封面 | ||
├─ paymentMethod | integer | 必须 | 支付方式 | ||
├─ expireAt | string,null | 必须 | 过期时间 | ||
├─ pat | string | 必须 | 开通时间 | ||
├─ tags | string | 必须 | 1: '普通订单', 2: '拼团', 4: '买赠', 8: '限时购', 12: '买赠', 16: '好友助力', 32: '兑换码', 64: '系统赠送', 128: '涨粉神器', 256: '亲情卡', 512: '普通订单', 1024: '积分商城', 2048: '大转盘', 4096: '砍价', 8192: '支付有礼', 16384: '直播抽奖', 32768: '直播福利', 262144: '股东赠送', 131072: '邀请活动奖励', 524288: '实物带货', 2097152: '企业团购', 4194304: '推荐有礼', 65536: '普通订单', 66048: '普通订单', 8388608: '礼包赠送', 134217728: '搭配购', 16777216: '圈子任务' | ||
├─ total | integer | 必须 | 总条数 |
Path: /api/openplatform/members/myKnowledgeOrders
Method: POST
接口描述:
userId、mobile、unionId至少必须传递一个值
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
mobile | 否 | 手机号 | |
unionId | 否 | 用户的unionId | |
userId | 否 | 用户id | |
startAt | 否 | 搜索开始时间 | |
endAt | 否 | 搜索结束时间 | |
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 | ||
limit | 否 | ||
page | 否 | ||
prodName | 否 | 产品名称 | |
orderNo | 否 | 订单号 | |
status | 否 | 订单状态 0未支付 1已支付 -3退款 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | object | 必须 | |||
├─ data | object [] | 必须 | item 类型: object | ||
├─ prodName | string | 必须 | 商品名称 | ||
├─ prodType | string | 必须 | 商品类型 | ||
├─ tags | string | 必须 | 订单类型 | ||
├─ payMoney | string | 必须 | 实付金额 | ||
├─ status | string | 必须 | 状态 | ||
├─ payAt | string,null | 必须 | 支付时间 | ||
├─ orderNo | string | 必须 | 订单号 | ||
├─ prodId | integer | 必须 | 产品id | ||
├─ createdAt | string | 必须 | 创建时间 | ||
├─ paymentMethod | string | 必须 | 支付方式 | ||
├─ total | integer | 必须 | 总条数 |
Path: /api/openplatform/members/userAsset
Method: POST
接口描述:
userId、mobile、unionId至少必须传递一个值
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
userId | 否 | 用户Id | |
mobile | 否 | 手机号 | |
unionId | 否 | 用户的unionId | |
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | object | 必须 | |||
├─ knowledgeIncome | object | 必须 | 知识收入(包含知识和商城收入) | ||
├─ noWithdrawal | number | 必须 | |||
├─ allIncomes | number | 必须 | |||
├─ freezeIncomes | number | 必须 | |||
├─ withdrawalAmount | number | 必须 | |||
├─ shareholderDataIncome | object | 必须 | 股东收益 | ||
├─ freezeIncomes | number | 必须 | |||
├─ withdrawalAmount | number | 必须 | |||
├─ allIncomes | number | 必须 | |||
├─ noWithdrawal | number | 必须 | |||
├─ mallWxAmount | object | 必须 | 视频号收入 | ||
├─ noWithdrawal | number | 必须 | |||
├─ allIncomes | number | 必须 | |||
├─ freezeIncomes | number | 必须 | |||
├─ withdrawalAmount | number | 必须 | |||
├─ distributionIncome | object | 必须 | 推广收入(内容市场的推广收入) | ||
├─ allIncomes | number | 必须 | |||
├─ distributionWithdrawalAmount | number | 必须 | |||
├─ noWithdrawal | number | 必须 | |||
├─ coinAmount | integer | 必须 | 虚拟币余额 | ||
├─ point | integer | 必须 | 积分 | ||
├─ couponNum | integer | 必须 | 优惠券数量 | ||
├─ exCouponNum | integer | 必须 | 兑换券数量 |
Path: /api/openplatform/getToken
Method: GET
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | 是 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
appid | 是 | ||
timestamp | 是 | ||
hc | 是 | ||
sign | 是 | ||
mobile | 是 | 用户手机号 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
extra | object | 非必须 | |||
├─ s | string | 非必须 | |||
data | object | 非必须 | |||
├─ u | string | 非必须 | |||
├─ c | string | 非必须 | |||
├─ t | string | 非必须 |
Path: /api/openplatform/members/userBlackList
Method: POST
接口描述:
此列表仅供查询加入模块黑名单或全店黑名单的学员!
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 | ||
userId | 否 | 用户id | |
moduleType | 否 | 黑名单类型 -1全店铺黑名单;5课程黑名单;10直播黑名单 | |
page | 否 | ||
limit | 否 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | object | 必须 | |||
├─ data | object [] | 必须 | item 类型: object | ||
├─ userId | string | 必须 | 用户id | ||
├─ nickname | string | 必须 | 昵称 | ||
├─ headimgurl | string | 必须 | 头像 | ||
├─ prodTypes | string [] | 必须 | item 类型: string | ||
├─ | 非必须 | 5:课程黑名单 10:直播黑名单 | |||
├─ moduleType | integer | 必须 | 1全店铺黑名单,2课程或者直播黑名单 | ||
├─ total | integer | 必须 | 总条数 |
Path: /api/openplatform/live/getLiveVideoWatchPeople
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
liveId | number | 必须 | 直播ID | ||
startAt | string | 必须 | 开始时间 | ||
endAt | string | 必须 | 结束时间 | ||
timestamp | number | 必须 | |||
appid | string | 必须 | |||
hc | string | 必须 | |||
sign | string | 必须 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ countData | string [] | 非必须 | 时间(横坐标) | item 类型: string | |
├─ | 非必须 | ||||
├─ data | number [] | 非必须 | 观看人数(纵坐标) | item 类型: number | |
├─ | 非必须 | ||||
├─ name | string | 非必须 | 直播名称 | ||
├─ endAt | string | 非必须 | 开始时间 | ||
├─ startAt | string | 非必须 | 结束时间 | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/live/getLiveCouponData
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
liveId | number | 必须 | 直播ID | ||
page | number | 非必须 | |||
limit | number | 非必须 | |||
timestamp | number | 非必须 | |||
appid | string | 非必须 | |||
hc | string | 非必须 | |||
sign | string | 非必须 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ data | object [] | 非必须 | item 类型: object | ||
├─ id | number | 必须 | |||
├─ prodId | number | 必须 | 优惠券ID | ||
├─ prodType | number | 必须 | 优惠券类型:92-优惠券;200-代金券;5000-有价优惠券 | ||
├─ relationId | number | 必须 | 关联Id | ||
├─ relationType | number | 必须 | |||
├─ status | number | 必须 | |||
├─ imgUrl | string | 必须 | |||
├─ name | string | 必须 | |||
├─ price | string,number | 必须 | |||
├─ getNum | number | 必须 | |||
├─ userNum | number | 必须 | |||
├─ stock | number | 必须 | |||
├─ content | string | 必须 | |||
├─ total | number | 非必须 | |||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/live/getLiveGoodSaleData
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
liveId | number | 必须 | 直播ID | ||
page | number | 非必须 | |||
limit | number | 非必须 | |||
timestamp | number | 非必须 | |||
appid | string | 非必须 | |||
hc | string | 非必须 | |||
sign | string | 非必须 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ total | number | 非必须 | |||
├─ data | object [] | 非必须 | item 类型: object | ||
├─ id | number | 必须 | |||
├─ prodId | number | 必须 | 商品ID | ||
├─ prodType | number | 必须 | 产品类型 | ||
├─ relationId | number | 必须 | 关联营销类型产品id | ||
├─ relationType | string | 必须 | 关联营销产品类型 1限时折扣 2拼团 7优惠券 | ||
├─ status | number | 必须 | 商品状态 | ||
├─ imgUrl | string | 必须 | 商品图片 | ||
├─ name | string | 必须 | 商品名称 | ||
├─ price | string,number | 必须 | 价格 | ||
├─ clickNum | number | 必须 | 点击次数 | ||
├─ userNum | number | 必须 | 点击人数 | ||
├─ totalUser | number | 必须 | 成交人数 | ||
├─ orderNum | number | 必须 | 订单数 | ||
├─ orderPayMoney | number | 必须 | 成交金额 | ||
├─ refund | number | 必须 | 退款金额 | ||
├─ quantity | number | 必须 | 销量 | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/live/getLivePurchaseRecord
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
liveId | number | 必须 | 直播Id | ||
searchName | string | 非必须 | 用户昵称 | ||
page | number | 非必须 | |||
limit | number | 非必须 | |||
timestamp | number | 必须 | |||
appid | string | 必须 | |||
hc | string | 必须 | |||
sign | string | 必须 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ data | object [] | 非必须 | item 类型: object | ||
├─ userNickname | string | 必须 | 昵称 | ||
├─ userAvatar | string | 必须 | 头像 | ||
├─ userMobile | string | 必须 | 手机号 | ||
├─ realName | string | 必须 | 真实姓名 | ||
├─ userId | string | 必须 | 用户ID | ||
├─ userUnionid | string | 必须 | unionid | ||
├─ prodName | string | 必须 | 产品名称 | ||
├─ prodPrice | string | 必须 | 产品价格 | ||
├─ payMoney | string | 必须 | 支付金额 | ||
├─ payAt | string | 必须 | 支付时间 | ||
├─ isNewUser | number | 必须 | 是否是新用户:1-是;0-否 | ||
├─ total | number | 非必须 | |||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/live/userWatchList
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
liveId | string | 必须 | 直播ID | ||
page | string | 必须 | 页码 | ||
limit | string | 必须 | 条数 | ||
nickname | string | 非必须 | 用户昵称 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ data | object [] | 非必须 | 列表 | item 类型: object | |
├─ liveId | number | 必须 | 直播ID | ||
├─ userId | string | 必须 | 用户ID | ||
├─ userUnionid | string | 必须 | 用户unionid | ||
├─ userNickname | string | 必须 | 用户昵称 | ||
├─ userAvatar | string | 必须 | 用户头像 | ||
├─ userMobile | string | 必须 | 用户手机 | ||
├─ firstInTime | string | 必须 | 首次观看时间 | ||
├─ lastInTime | string | 必须 | 最近一次观看时间 | ||
├─ hisLearnTime | number | 必须 | 总学习时长,单位秒 | ||
├─ liveLearnTime | number | 必须 | 直播观看时长,单位秒 | ||
├─ backLearnTime | number | 必须 | 回放观看时长,单位秒 | ||
├─ total | number | 非必须 | 总条数 | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/live/liveList
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
isFilterDel | string | 非必须 | 是否过滤删除直播:0否 1是 | ||
startAt | string | 非必须 | 开播时间起始 | mock: 2023-06-23 10:00:00 | |
endAt | string | 非必须 | 开播时间截止 | mock: 2023-06-23 10:00:00 | |
name | string | 非必须 | 直播名称 | ||
page | string | 必须 | 页码 | ||
limit | string | 必须 | 每页条数,1-100 | ||
timestamp | string | 必须 | |||
appid | string | 必须 | |||
hc | string | 必须 | |||
sign | string | 必须 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ data | object [] | 非必须 | item 类型: object | ||
├─ id | number | 必须 | 直播ID | ||
├─ name | string | 必须 | 名称 | ||
├─ liveBrief | string | 必须 | 简介 | ||
├─ liveCover | string | 必须 | 封面 | ||
├─ liveWarmCover | string | 必须 | 暖场图 | ||
├─ startAt | string | 必须 | 开始时间 | ||
├─ endAt | string | 必须 | 结束时间 | ||
├─ liveType | number | 必须 | 类型:1视频直播 3语音直播 4PPT直播 5PC视频直播 6互动直播 7转播 | ||
├─ payType | number | 必须 | 支付方式:1免费 2付费 3加密 | ||
├─ price | string | 必须 | 价格 | ||
├─ status | number | 必须 | 状态:0未开始 1直播中 2已结束 3删除 | ||
├─ shelfStatus | number | 必须 | 上架状态 1上架 2下架 3定时上架 | ||
├─ pageUrl | string | 必须 | 直播H5地址 | ||
├─ createdAt | string | 必须 | 创建时间 | ||
├─ updatedAt | string | 必须 | 更新时间 | ||
├─ total | number | 非必须 | 总条数 | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/live/onlineMemberNum
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
liveId | string | 必须 | 直播ID | ||
prodType | string | 必须 | 产品类型:51 公开课; 180 直播间 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | 200 | ||
data | object | 非必须 | |||
├─ onlineNum | number | 非必须 | 在线人数 | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/live/getLiveGoodsOverview
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
liveId | number | 必须 | 直播ID | ||
timestamp | number | 必须 | |||
appid | string | 必须 | |||
hc | string | 必须 | |||
sign | string | 必须 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ totalUser | number | 非必须 | 总成交人数 | ||
├─ orderNum | number | 非必须 | 订单数 | ||
├─ orderPayMoney | number | 非必须 | 总成交金额 | ||
├─ refund | number | 非必须 | 总退款金额 | ||
├─ clickNum | number | 非必须 | 带货商品点击次数 | ||
├─ userNum | number | 非必须 | 带货商品点击人数 | ||
├─ lastTime | string | 非必须 | 上次更新时间 | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/live/getLiveRewardCount
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
liveId | number | 必须 | 直播ID | ||
timestamp | number | 非必须 | |||
appid | string | 非必须 | |||
hc | string | 非必须 | |||
sign | string | 非必须 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ rewardAmount | number | 非必须 | 打赏总金额(元) | ||
├─ rewardNumber | number | 非必须 | 打赏总人数 | ||
├─ coinAmount | number | 非必须 | 打赏总虚拟币 | ||
├─ companyIncome | number | 非必须 | 公司总收益 | ||
├─ companyCoinAmount | number | 非必须 | 公司虚拟币收益 | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/live/getLiveRewardList
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
liveId | number | 必须 | 直播ID | ||
mode | number | 非必须 | 模式:0金额打赏 1虚拟币打赏 | ||
page | number | 非必须 | |||
limit | number | 非必须 | |||
timestamp | number | 非必须 | |||
appid | string | 非必须 | |||
hc | string | 非必须 | |||
sign | string | 非必须 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ total | number | 非必须 | 总条数 | ||
├─ data | object [] | 非必须 | item 类型: object | ||
├─ userId | string | 必须 | 用户ID | ||
├─ nickname | string | 必须 | 用户昵称 | ||
├─ avatar | string | 必须 | 用户头像 | ||
├─ mobile | string | 必须 | 用户手机号 | ||
├─ unionid | string | 必须 | 用户unionid | ||
├─ beUserId | string | 必须 | 被打赏者用户ID | ||
├─ beNickname | string | 必须 | 被打赏者用户昵称 | ||
├─ beAvatar | string | 必须 | 被打赏者用户头像 | ||
├─ orderId | number | 必须 | 打赏订单ID | ||
├─ payAt | string | 必须 | 打赏时间 | ||
├─ payMoney | number | 必须 | 打赏金额(元) | ||
├─ companyIncome | number | 必须 | 公司收益(元) | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/live/getLiveOverview
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
liveId | number | 必须 | 直播ID | ||
timestamp | number | 必须 | |||
appid | string | 必须 | |||
hc | string | 必须 | |||
sign | string | 必须 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ name | string | 非必须 | 直播名称 | ||
├─ endAt | string | 非必须 | 结束时间 | ||
├─ startAt | string | 非必须 | 开始时间 | ||
├─ watchNum | number | 非必须 | 累计在线人数 | ||
├─ newUserNum | number | 非必须 | 新用户数 | ||
├─ watchTimes | number | 非必须 | 累计观看人次 | ||
├─ liveType | number | 非必须 | 直播类型【0=视频录播+社群直播; 1=OBS实时直播; 2=手机直播 (1跟2合并成视频直播); 3=语音直播; 4=PPT直播; 5=PC视频直播; 6=互动视频直播; 7=转播;】 | ||
├─ flow | string | 非必须 | 流量花费 | ||
├─ hasStream | number | 非必须 | |||
├─ pushTime | object [] | 非必须 | 推流时间 | item 类型: object | |
├─ start | string | 必须 | 开始时间 | ||
├─ end | string | 必须 | 结束时间 | ||
├─ liveUserNum | number | 非必须 | 直播中观看人数 | ||
├─ avgOnlineNum | number | 非必须 | 直播中平均在线人数 | ||
├─ maxOnlineNum | number | 非必须 | 直播中峰值人数 | ||
├─ avgWatchTime | string | 非必须 | 直播中平均观看 | ||
├─ liveReviewUserNum | number | 非必须 | 回放观看人数 | ||
├─ avgReviewNum | number | 非必须 | 回放平均在线人数 | ||
├─ avgReviewWatchTime | string | 非必须 | 回放平均观看时长 | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/live/getMessageList
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
liveId | string | 必须 | 直播ID | ||
page | string | 必须 | 页码 | ||
limit | string | 必须 | 条数 | ||
searchName | string | 非必须 | 用户昵称 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ total | number | 非必须 | 总条数 | ||
├─ data | object [] | 非必须 | item 类型: object | ||
├─ userId | string | 必须 | 用户ID | ||
├─ nickname | string | 必须 | 用户昵称 | ||
├─ realName | string | 必须 | 用户真名 | ||
├─ mobile | string | 必须 | 用户手机号 | ||
├─ unionid | string | 必须 | 用户unionid | ||
├─ msgType | number | 必须 | 消息类型:1文本; 2图片; 3语音 4视频 18提问 19回答 70带货 | ||
├─ content | string | 必须 | 消息内容 | ||
├─ createdAt | string | 必须 | 发布时间 | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/live/getLiveBitRateInfo
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
liveId | number | 必须 | 直播ID | ||
timestamp | number | 必须 | |||
appid | string | 必须 | |||
hc | string | 必须 | |||
sign | string | 必须 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ time | string [] | 非必须 | 时间 | item 类型: string | |
├─ | 非必须 | ||||
├─ data | number [] | 非必须 | 码率(bps) | item 类型: number | |
├─ | 非必须 | ||||
├─ audio | number [] | 非必须 | 音频帧率(ftps) | item 类型: number | |
├─ | 非必须 | ||||
├─ video | number [] | 非必须 | 视频帧率(ftps) | item 类型: number | |
├─ | 非必须 | ||||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/live/liveInfo
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
liveId | string | 必须 | 直播ID |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ id | number | 非必须 | 直播ID | ||
├─ name | string | 非必须 | 直播名称 | ||
├─ liveBrief | string | 非必须 | 简介 | ||
├─ liveCover | string | 非必须 | 封面 | ||
├─ liveWarmCover | string | 非必须 | 暖场图 | ||
├─ startAt | string | 非必须 | 开始时间 | ||
├─ endAt | string | 非必须 | 结束时间 | ||
├─ payType | number | 非必须 | 支付方式:1免费 2付费 3加密 | ||
├─ price | string | 非必须 | 价格 | ||
├─ status | number | 非必须 | 状态: 0未开始 1直播中 2已结束 3删除 | ||
├─ liveType | number | 非必须 | 类型:1视频直播 3语音直播 4PPT直播 5PC视频直播 6互动直播 7转播 | ||
├─ liveSubType | number | 非必须 | 选择模式:1一般直播 2快直播 | ||
├─ playType | number | 非必须 | 播放形式:1横屏 2竖屏 | ||
├─ createdAt | string | 非必须 | 创建时间 | ||
├─ updatedAt | string | 非必须 | 更新时间 | ||
├─ lecturerList | object [] | 非必须 | 讲师列表 | item 类型: object | |
├─ unionid | string,null | 非必须 | 讲师unionid | ||
├─ nickname | string | 非必须 | 讲师昵称 | ||
├─ realName | string | 非必须 | 讲师名称 | ||
├─ avatar | string | 非必须 | 讲师头像 | ||
├─ mobile | string,null | 非必须 | 讲师电话 | ||
├─ subRole | number | 非必须 | 是否嘉宾:0否 1是 | ||
├─ categoryList | object [] | 必须 | 分类 | item 类型: object | |
├─ level1CatId | string | 必须 | 1级分类ID | ||
├─ level2CatId | string | 必须 | 2级分类ID | ||
├─ level3CatId | string | 必须 | 3级分类ID | ||
├─ level1CatName | string | 必须 | 1级分类名称 | ||
├─ level2CatName | string | 必须 | 2级分类名称 | ||
├─ level3CatName | string | 必须 | 3级分类名称 | ||
├─ rewardAmount | string | 非必须 | 打赏金额 | ||
├─ rewardNumber | number | 非必须 | 打赏人数 | ||
├─ coinAmount | string | 非必须 | 虚拟币打赏 | ||
├─ viewNumber | number | 非必须 | 访问人次 | ||
├─ onlineNumber | number | 非必须 | 在线人数峰值 | ||
├─ columnList | object [] | 非必须 | 关联专栏 | item 类型: object | |
├─ columnId | string | 非必须 | 专栏ID | ||
├─ name | string | 非必须 | 名称 | ||
├─ cover | string | 非必须 | 封面 | ||
├─ payType | string | 非必须 | 支付方式:1免费 2付费 3加密 | ||
├─ price | string | 非必须 | 价格 | ||
├─ comboList | object [] | 非必须 | 关联知识套餐 | item 类型: object | |
├─ cId | string | 非必须 | 套餐ID | ||
├─ name | string | 非必须 | 名称 | ||
├─ cover | string | 非必须 | 封面 | ||
├─ payType | string | 非必须 | 支付方式:1免费 2付费 3加密 | ||
├─ price | string | 非必须 | 价格 |
Path: /api/openplatform/live/getLiveInviteList
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
liveId | string | 必须 | 直播ID | ||
page | string | 必须 | 页码 | ||
limit | string | 必须 | 每页条数,1-100 | ||
timestamp | string | 必须 | |||
appid | string | 必须 | |||
hc | string | 必须 | |||
sign | string | 必须 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ total | number | 非必须 | 总条数 | ||
├─ data | object [] | 非必须 | item 类型: object | ||
├─ userId | string | 必须 | 用户ID | ||
├─ nickname | string | 必须 | 用户昵称 | ||
├─ realName | string | 必须 | 用户真名 | ||
├─ headimgurl | string | 必须 | 用户头像 | ||
├─ mobile | string | 必须 | 用户手机号 | ||
├─ unionid | string | 必须 | 用户unionid | ||
├─ iUserId | string | 必须 | 邀请人用户ID | ||
├─ iNickname | string | 必须 | 邀请人用户昵称 | ||
├─ iRealName | string | 必须 | 邀请人真名 | ||
├─ iMobile | string | 必须 | 邀请人手机号 | ||
├─ iUnionid | string | 必须 | 邀请人unionid | ||
├─ ruserId | string | 必须 | 推荐人用户ID | ||
├─ rNickname | string | 必须 | 推荐人昵称 | ||
├─ rrealName | string | 必须 | 推荐人真名 | ||
├─ rmobile | string | 必须 | 推荐人手机号 | ||
├─ isNewUser | number | 必须 | 是否新用户:0否 1是 | ||
├─ inviteNum | number | 必须 | 邀请人数 | ||
├─ createdAt | string | 必须 | 进入直播间时间 | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/live/getInviteUserList
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
liveId | string | 必须 | 直播ID | ||
userId | string | 必须 | 用户ID | ||
page | string | 必须 | 页码 | ||
limit | string | 必须 | 条数 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ total | number | 非必须 | |||
├─ data | object [] | 非必须 | item 类型: object | ||
├─ userId | string | 非必须 | 用户ID | ||
├─ nickname | string | 非必须 | 用户昵称 | ||
├─ headimgurl | string | 非必须 | 用户头像 | ||
├─ mobile | string | 非必须 | 用户手机号 | ||
├─ unionid | string | 非必须 | 用户unionid | ||
├─ createdAt | string | 非必须 | 进入时间 | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/live/getLiveRemindList
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
liveId | number | 必须 | 直播ID | ||
page | number | 非必须 | |||
limit | number | 非必须 | |||
timestamp | number | 非必须 | |||
appid | string | 非必须 | |||
hc | string | 非必须 | |||
sign | string | 非必须 | |||
startAt | string | 非必须 | 预约日期,如 2023-07-07 | ||
endAt | string | 非必须 | 预约日期,如 2023-07-08 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ total | number | 非必须 | 总条数 | ||
├─ data | object [] | 非必须 | item 类型: object | ||
├─ userId | string | 非必须 | 用户ID | ||
├─ nickname | string | 非必须 | 用户昵称 | ||
├─ headimgurl | string | 非必须 | 用户头像 | ||
├─ realName | string | 非必须 | 用户真名 | ||
├─ mobile | string | 非必须 | 用户手机号 | ||
├─ unionid | string | 非必须 | 用户unionid | ||
├─ ruserId | string | 非必须 | 推荐人ID | ||
├─ rnickname | string | 非必须 | 推荐人昵称 | ||
├─ rrealName | string | 非必须 | 推荐人真名 | ||
├─ rmobile | string | 非必须 | 推荐人手机号 | ||
├─ createdAt | string | 非必须 | 预约时间 | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/livePersonal/detailCouponList
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
detailId | string | 必须 | 场次ID | ||
page | string | 必须 | 页码 | ||
limit | string | 必须 | 条数 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ total | number | 非必须 | 总条数 | ||
├─ data | object [] | 非必须 | item 类型: object | ||
├─ id | number | 必须 | |||
├─ prodId | number | 必须 | 产品ID | ||
├─ prodType | number | 必须 | 产品类型 | ||
├─ relationId | number | 必须 | 关联营销类型产品id | ||
├─ relationType | number | 必须 | 关联营销产品类型 1限时折扣 2拼团 7优惠券 | ||
├─ status | number | 必须 | 商品状态 | ||
├─ imgUrl | string | 必须 | 商品图片 | ||
├─ name | string | 必须 | 商品名称 | ||
├─ price | number | 必须 | 价格 | ||
├─ getNum | number | 必须 | 已领取张数 | ||
├─ userNum | number | 必须 | 领取人数 | ||
├─ stock | number | 必须 | 剩余张数 | ||
├─ content | string | 必须 | 优惠券内容 | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/livePersonal/detailPurchaseList
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
detailId | string | 必须 | 场次ID | ||
searchName | string | 非必须 | 用户昵称 | ||
page | string | 必须 | 页码 | ||
limit | string | 必须 | 条数 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ data | object [] | 非必须 | item 类型: object | ||
├─ userNickname | string | 非必须 | 用户昵称 | ||
├─ userAvatar | string | 非必须 | 用户头像 | ||
├─ userMobile | string | 非必须 | 用户手机号 | ||
├─ realName | string | 非必须 | 用户真名 | ||
├─ userId | string | 非必须 | 用户ID | ||
├─ userUnionid | string | 非必须 | 用户unionid | ||
├─ prodName | string | 非必须 | 产品名称 | ||
├─ prodPrice | string | 非必须 | 产品价格 | ||
├─ payMoney | string | 非必须 | 支付金额 | ||
├─ payAt | string | 非必须 | 支付时间 | ||
├─ isNewUser | number | 非必须 | 是否新用户:0否 1是 | ||
├─ total | number | 非必须 | 总条数 | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/livePersonal/detailGoodsSaleList
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
detailId | string | 必须 | 场次ID | ||
page | string | 必须 | 页码 | ||
limit | string | 必须 | 条数 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ total | number | 非必须 | 总条数 | ||
├─ data | object [] | 非必须 | item 类型: object | ||
├─ id | number | 必须 | |||
├─ prodId | number | 必须 | 商品ID | ||
├─ prodType | number | 必须 | 商品类型 | ||
├─ relationId | number | 必须 | 关联营销类型产品id | ||
├─ relationType | number | 必须 | 关联营销产品类型 1限时折扣 2拼团 7优惠券 | ||
├─ status | number | 必须 | 商品状态 | ||
├─ imgUrl | string | 必须 | 商品图片 | ||
├─ name | string | 必须 | 商品名称 | ||
├─ price | string | 必须 | 价格 | ||
├─ clickNum | number | 必须 | 点击次数 | ||
├─ userNum | number | 必须 | 点击人数 | ||
├─ totalUser | number | 必须 | 成交人数 | ||
├─ orderNum | number | 必须 | 订单数 | ||
├─ orderPayMoney | number | 必须 | 成交金额 | ||
├─ refund | number | 必须 | 退款金额 | ||
├─ quantity | number | 必须 | 销量 | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/livePersonal/detailRewardCount
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
detailId | string | 必须 | 场次ID |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ rewardAmount | number | 非必须 | 打赏金额(元) | ||
├─ rewardNumber | number | 非必须 | 打赏人数(人) | ||
├─ coinAmount | number | 非必须 | 打赏虚拟币(币) | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/livePersonal/detailRewardList
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
detailId | string | 必须 | 场次ID | ||
mode | string | 必须 | 模式:0打赏金额(默认) 1打赏虚拟币 | ||
page | string | 必须 | 页码 | ||
limit | string | 必须 | 条数 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ total | number | 非必须 | 总条数 | ||
├─ data | object [] | 非必须 | item 类型: object | ||
├─ userId | string | 必须 | 用户ID | ||
├─ nickname | string | 必须 | 用户昵称 | ||
├─ avatar | string | 必须 | 用户头像 | ||
├─ mobile | string | 必须 | 用户手机号 | ||
├─ unionid | string | 必须 | 用户unionid | ||
├─ beUserId | string | 必须 | 被打赏者用户ID | ||
├─ beNickname | string | 必须 | 被打赏者用户昵称 | ||
├─ beAvatar | string | 必须 | 被打赏者用户头像 | ||
├─ orderId | number | 必须 | 打赏订单ID | ||
├─ payAt | string | 必须 | 支付时间 | ||
├─ payMoney | number | 必须 | 支付金额(元) | ||
├─ companyIncome | number | 必须 | 公司收益(元) | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/livePersonal/liveDetailOverview
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
detailId | string | 必须 | 场次ID |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ liveWatchNum | number | 非必须 | 观看人次 | ||
├─ liveUserNum | number | 非必须 | 直播中观看人数 | ||
├─ avgOnlineNum | number | 非必须 | 直播中平均在线人数 | ||
├─ maxOnlineNum | number | 非必须 | 直播中在线峰值人数 | ||
├─ avgWatchTime | string | 非必须 | 直播中平均观看时长 | ||
├─ liveReviewUserNum | number | 非必须 | 回放观看人数 | ||
├─ avgReviewNum | number | 非必须 | 回放平均在线人数 | ||
├─ avgReviewWatchTime | string | 非必须 | 回放平均观看时长 | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/livePersonal/detailMessageList
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
searchName | string | 非必须 | 用户昵称 | ||
detailId | string | 必须 | 场次ID | ||
page | string | 必须 | |||
limit | string | 必须 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ total | number | 非必须 | 总条数 | ||
├─ data | object [] | 非必须 | item 类型: object | ||
├─ userId | string | 必须 | 用户ID | ||
├─ nickname | string | 必须 | 用户昵称 | ||
├─ realName | string | 必须 | 用户真名 | ||
├─ mobile | string | 必须 | 用户手机号 | ||
├─ unionid | string | 必须 | 用户unionid | ||
├─ msgType | number | 必须 | 消息类型:1文本; 2图片; 3语音 4视频 18提问 19回答 70带货 | ||
├─ content | string | 必须 | 消息内容 | ||
├─ createdAt | string | 必须 | 发布时间 | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/livePersonal/detailUserWatchList
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
detailId | string | 必须 | 场次ID | ||
nickname | string | 非必须 | 用户昵称 | ||
page | string | 必须 | 页码 | ||
limit | string | 必须 | 条数 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ total | number | 非必须 | 总条数 | ||
├─ data | object [] | 非必须 | 观看列表 | item 类型: object | |
├─ detailId | number | 必须 | 场次ID | ||
├─ userUnionid | string | 必须 | 用户unionid | ||
├─ userNickname | string | 必须 | 用户昵称 | ||
├─ userAvatar | string | 必须 | 用户头像 | ||
├─ userMobile | string | 必须 | 用户手机号 | ||
├─ firstInTime | string | 必须 | 首次观看时间 | ||
├─ lastInTime | string | 必须 | 最近观看时间 | ||
├─ hisLearnTime | number | 必须 | 总观看时长,单位秒 | ||
├─ liveLearnTime | number | 必须 | 直播观看时长,单位秒 | ||
├─ backLearnTime | number | 必须 | 回放观看时长,单位秒 | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/livePersonal/detailInviteList
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
detailId | string | 必须 | 场次ID | ||
page | string | 必须 | 页码 | ||
limit | string | 必须 | 条数 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ total | number | 非必须 | 总条数 | ||
├─ data | object [] | 非必须 | item 类型: object | ||
├─ userId | string | 必须 | 用户ID | ||
├─ nickname | string | 必须 | 用户昵称 | ||
├─ realName | string,null | 必须 | 用户真名 | ||
├─ headimgurl | string | 必须 | 用户头像 | ||
├─ mobile | string | 必须 | 用户手机号 | ||
├─ unionid | string | 必须 | 用户unionid | ||
├─ iUserId | string | 必须 | 邀请人ID | ||
├─ iNickname | string | 必须 | 邀请人昵称 | ||
├─ iRealName | string | 必须 | 邀请人真名 | ||
├─ iMobile | string | 必须 | 邀请人手机 | ||
├─ iUnionid | string | 必须 | 邀请人unionid | ||
├─ ruserId | string | 必须 | 推荐人ID | ||
├─ rNickname | string | 必须 | 推荐人昵称 | ||
├─ rrealName | string | 必须 | 推荐人真名 | ||
├─ rmobile | string | 必须 | 推荐人手机 | ||
├─ isNewUser | number | 必须 | 是否新用户:0否 1是 | ||
├─ inviteNum | number | 必须 | 邀请人数 | ||
├─ createdAt | string | 必须 | 进入直播间时间 | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/livePersonal/detailInviteUserList
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
detailId | string | 必须 | 场次ID | ||
userId | string | 必须 | 用户ID | ||
page | string | 必须 | 页码 | ||
limit | string | 必须 | 条数 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ total | number | 非必须 | |||
├─ data | object [] | 非必须 | item 类型: object | ||
├─ userId | string | 必须 | 用户ID | ||
├─ nickname | string | 必须 | 用户昵称 | ||
├─ headimgurl | string | 必须 | 用户头像 | ||
├─ realName | string | 必须 | 用户真名 | ||
├─ mobile | string | 必须 | 用户手机号 | ||
├─ unionid | string | 必须 | 用户unionid | ||
├─ ruserId | string | 必须 | 推荐人ID | ||
├─ rnickname | string | 必须 | 推荐人昵称 | ||
├─ rrealName | string | 必须 | 推荐人真名 | ||
├─ createdAt | string | 必须 | 最近一次预约时间 | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/livePersonal/liveList
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
isFilterDel | string | 非必须 | 是否过滤已删除直播间:0否 1是 | ||
name | string | 非必须 | 直播名称 | ||
page | string | 必须 | 页码 | ||
limit | string | 必须 | 条数 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ data | object [] | 非必须 | 直播列表 | item 类型: object | |
├─ lpId | number | 必须 | 直播间ID | ||
├─ name | string | 必须 | 名称 | ||
├─ cover | string | 必须 | 封面 | ||
├─ liveBrief | string | 必须 | 简介 | ||
├─ liveWarmCover | string | 必须 | 暖场图 | ||
├─ endDate | null | 必须 | 直播有效期 | ||
├─ payType | number | 必须 | 支付方式:1免费 2付费 3加密 | ||
├─ price | string | 必须 | 价格 | ||
├─ status | number | 必须 | 状态: -1删除 1正常 2下架 3定时上架 | ||
├─ pageUrl | string | 必须 | 直播间H5地址 | ||
├─ createdAt | string | 必须 | 创建时间 | ||
├─ updatedAt | string | 必须 | 更新时间 | ||
├─ total | number | 非必须 | 总条数 | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/livePersonal/liveDetailList
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
isFilterDel | string | 非必须 | 是否过滤已删除场次:0否 1是 | ||
liveId | string | 必须 | 直播间ID | ||
page | string | 必须 | 页码 | ||
limit | string | 必须 | 条数 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ data | object [] | 非必须 | 场次列表 | item 类型: object | |
├─ detailId | number | 必须 | 场次ID | ||
├─ name | string | 必须 | 名称 | ||
├─ lpId | number | 必须 | 直播间ID | ||
├─ cover | string | 必须 | 封面 | ||
├─ playType | number | 必须 | 播放形式:1横屏 2竖屏 | ||
├─ endAt | string | 必须 | 结束时间 | ||
├─ duration | number | 必须 | 时长 | ||
├─ fromType | number | 必须 | 来源: 1直播 2剪切 3本地上传 4素材库上传 | ||
├─ parentId | number | 必须 | 关联场次ID | ||
├─ watchNum | number | 必须 | 访问次数 | ||
├─ reviewNow | number | 必须 | 是否设为回放:0否 1是 | ||
├─ status | number | 必须 | 状态 1直播中 2已结束 -1删除 | ||
├─ createdAt | string | 必须 | 创建时间 | ||
├─ total | number | 非必须 | 总条数 | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/livePersonal/liveDetailInfo
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
detailId | string | 必须 | 场次ID |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ detailId | number | 非必须 | 场次ID | ||
├─ name | string | 非必须 | 名称 | ||
├─ lpId | number | 非必须 | 直播间ID | ||
├─ cover | string | 非必须 | 封面 | ||
├─ playType | number | 非必须 | 播放形式:1横屏 2竖屏 | ||
├─ endAt | null | 非必须 | 结束时间 | ||
├─ duration | number | 非必须 | 时长,单位秒 | ||
├─ status | number | 非必须 | 状态:1直播中 2已结束 -1删除 | ||
├─ fromType | number | 非必须 | 来源类型:1直播 2剪切 3本地上传 4素材库上传 | ||
├─ parentId | number | 非必须 | 关联场次ID | ||
├─ reviewNow | number | 非必须 | 是否设为回放:0否 1是 | ||
├─ createdAt | string | 非必须 | 创建时间 | ||
├─ viewNumber | number | 非必须 | 访问次数 | ||
├─ rewardAmount | number | 非必须 | 打赏金额 | ||
├─ rewardNumber | number | 非必须 | 打赏人数 | ||
├─ coinAmount | number | 非必须 | 打赏虚拟币数 | ||
├─ onlineNumber | number | 非必须 | 在线人数峰值 | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/livePersonal/liveWatchPeople
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
liveId | string | 必须 | 直播间ID | ||
startAt | string | 必须 | 开始时间 | ||
endAt | string | 必须 | 结束时间 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ countData | string [] | 非必须 | 时间列表 | item 类型: string | |
├─ | 非必须 | ||||
├─ data | number [] | 非必须 | 人数列表 | item 类型: number | |
├─ | 非必须 | ||||
├─ name | string | 非必须 | 直播间名称 | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/livePersonal/liveDetailAll
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
isLive | string | 必须 | 是否只获取直播产生场次:0否 1是;用于查在线人数、码率、带货等(不包含上传、剪切产生的场次) | ||
liveId | string | 必须 | 直播间ID |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object [] | 非必须 | item 类型: object | ||
├─ detailId | number | 必须 | 场次ID | ||
├─ name | string | 必须 | 场次名称 | ||
├─ createdAt | string | 必须 | 创建时间 | ||
├─ endAt | number | 必须 | 结束时间 | ||
├─ fromType | string | 必须 | 来源:1直播 2剪切 3本地上传 4素材库上传 | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/livePersonal/liveGoodsOverview
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
liveId | string | 必须 | 直播间ID | ||
detailId | string | 非必须 | 场次ID |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ totalUser | number | 非必须 | 总成交人数 | ||
├─ orderNum | number | 非必须 | 总订单数 | ||
├─ orderPayMoney | number | 非必须 | 总成交金额 | ||
├─ refund | number | 非必须 | 总退款金额 | ||
├─ clickNum | number | 非必须 | 带货商品点击次数 | ||
├─ userNum | number | 非必须 | 带货商品点击人数 | ||
├─ lastTime | string | 非必须 | 上次更新时间 | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/livePersonal/liveRewardCount
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
liveId | string | 必须 | 直播间ID |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ rewardAmount | number | 非必须 | 打赏总金额 | ||
├─ rewardNumber | number | 非必须 | 打赏总人数 | ||
├─ coinAmount | number | 非必须 | 打赏总虚拟币(币) | ||
├─ companyIncome | number | 非必须 | 公司总收益(元) | ||
├─ companyCoinAmount | number | 非必须 | 公司虚拟币收益(币) | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/livePersonal/liveOverview
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
liveId | string | 必须 | 直播间ID |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ name | string | 非必须 | 直播间名称 | ||
├─ watchNum | number | 非必须 | 参与人数 | ||
├─ newUserNum | number | 非必须 | 新用户数 | ||
├─ watchTimes | number | 非必须 | 访问量 | ||
├─ flow | string | 非必须 | 消耗流量 | ||
├─ pushTime | object [] | 非必须 | 直播时间 | item 类型: object | |
├─ start | string | 必须 | 开始时间 | ||
├─ end | string | 必须 | 结束时间 | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/livePersonal/liveBitRate
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
liveId | string | 必须 | 直播间ID | ||
startAt | string | 必须 | 开始时间 | ||
endAt | string | 必须 | 结束时间 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ time | string [] | 非必须 | 时间 | item 类型: string | |
├─ | 非必须 | ||||
├─ data | number [] | 非必须 | 码率,单位bps | item 类型: number | |
├─ | 非必须 | ||||
├─ audio | number [] | 非必须 | 音频帧率,单位fps | item 类型: number | |
├─ | 非必须 | ||||
├─ video | number [] | 非必须 | 视频帧率,单位fps | item 类型: number | |
├─ | 非必须 | ||||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/livePersonal/liveInfo
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
liveId | string | 必须 | 直播ID |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ lpId | number | 非必须 | 直播间ID | ||
├─ name | string | 非必须 | 名称 | ||
├─ cover | string | 非必须 | 封面 | ||
├─ liveBrief | string | 非必须 | 简介 | ||
├─ liveWarmCover | string | 非必须 | 暖场图 | ||
├─ endDate | null | 非必须 | 直播有效期 | ||
├─ payType | number | 非必须 | 支付方式:1免费 2付费 3加密 | ||
├─ price | string | 非必须 | 价格 | ||
├─ status | number | 非必须 | 状态:-1删除 1正常 2下架 3定时上架 | ||
├─ createdAt | string | 非必须 | 创建时间 | ||
├─ updatedAt | string | 非必须 | 更新时间 | ||
├─ categoryList | object [] | 非必须 | 分类 | item 类型: object | |
├─ level1CatId | string | 非必须 | 1级分类ID | ||
├─ level2CatId | string | 非必须 | 2级分类ID | ||
├─ level3CatId | string | 非必须 | 3级分类ID | ||
├─ level1CatName | string | 非必须 | 1级分类名称 | ||
├─ level2CatName | string | 非必须 | 2级分类名称 | ||
├─ level3CatName | string | 非必须 | 3级分类名称 | ||
├─ viewNumber | number | 非必须 | 访问次数 | ||
├─ rewardAmount | number | 非必须 | 打赏金额 | ||
├─ rewardNumber | number | 非必须 | 打赏人数 | ||
├─ coinAmount | number | 非必须 | 打赏虚拟币数 | ||
├─ comboList | object [] | 非必须 | 关联知识套餐 | item 类型: object | |
├─ cId | string | 非必须 | 套餐ID | ||
├─ name | string | 非必须 | 名称 | ||
├─ cover | string | 非必须 | 封面 | ||
├─ payType | string | 非必须 | 支付方式:1免费 2付费 3加密 | ||
├─ price | string | 非必须 | 价格 | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/livePersonal/liveRemindList
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
liveId | string | 必须 | 直播间ID | ||
startAt | string | 必须 | 预约起始始日期 | ||
endAt | string | 必须 | 预约截止始日期 | ||
page | string | 必须 | 页码 | ||
limit | string | 必须 | 条数 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ total | number | 非必须 | |||
├─ data | object [] | 非必须 | item 类型: object | ||
├─ userId | string | 必须 | 用户ID | ||
├─ nickname | string | 必须 | 用户昵称 | ||
├─ headimgurl | string | 必须 | 用户头像 | ||
├─ realName | string | 必须 | 用户真名 | ||
├─ mobile | string | 必须 | 用户手机号 | ||
├─ unionid | string | 必须 | 用户unionid | ||
├─ ruserId | string | 必须 | 推荐人ID | ||
├─ rnickname | string | 必须 | 推荐人昵称 | ||
├─ rrealName | string | 必须 | 推荐人真名 | ||
├─ rmobile | string | 必须 | 推荐人手机号 | ||
├─ createdAt | string | 必须 | 最近一次预约时间 | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/orders/mallOrderDistribution
Method: POST
接口描述:
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 | ||
orderNo | 是 | 订单号 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | object [] | 必须 | item 类型: object | ||
├─ userId | string | 必须 | 用户id | ||
├─ nickname | string | 必须 | 昵称 | ||
├─ headimgurl | string | 必须 | 头像 | ||
├─ realName | string | 必须 | 真名 | ||
├─ mobile | string | 必须 | 手机号 | ||
├─ amount | string | 必须 | 收益金额 | ||
├─ orderNo | string | 必须 | 订单号 | ||
├─ tag | string | 必须 | 收益缘由 | ||
├─ ratios | string | 必须 | 收益比例 | ||
├─ status | integer | 必须 | 状态,1:已完成,2:待结算,0不分账 | ||
├─ createdAt | string | 必须 | 收益时间 | ||
├─ goodName | string | 必须 | 商品名称 |
Path: /api/openplatform/orders/customShips
Method: POST
接口描述:
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | object [] | 必须 | item 类型: object | ||
├─ shipId | integer | 必须 | 快递id | ||
├─ name | string | 必须 | 快递名称 | ||
├─ status | integer | 必须 |
Path: /api/openplatform/orders/logisticsInfo
Method: POST
接口描述:
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 | ||
orderNo | 是 | 订单号 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | object [] | 必须 | item 类型: object | ||
├─ goId | integer | 非必须 | 订单id | ||
├─ packageNo | integer | 非必须 | 包裹编号 | ||
├─ deliverAt | string | 非必须 | 发货时间 | ||
├─ shipNo | string | 非必须 | 快递单号 | ||
├─ shipId | integer | 非必须 | 快递id | ||
├─ shipName | string | 非必须 | 快递名称 | ||
├─ state | integer | 非必须 | 物流状态,0-无轨迹,1-已揽收,2-在途中,3-签收,4-问题件 | ||
├─ traces | string [] | 非必须 | 物流轨迹 | item 类型: string | |
├─ | 非必须 | ||||
├─ gopId | integer | 非必须 | 包裹id | ||
├─ deliverType | integer | 非必须 | 发货方式,1-物流配送,3-无需物流,2-线下自提 | ||
├─ goodsNum | integer | 非必须 | 商品数量 | ||
├─ goods | object [] | 非必须 | item 类型: object | ||
├─ godId | integer | 非必须 | 小订单id | ||
├─ goodsName | string | 非必须 | 商品名称 | ||
├─ avatar | string | 非必须 | 商品头图 | ||
├─ quantity | integer | 非必须 | 数量 | ||
├─ subSpecs | string | 非必须 | 规格 | ||
├─ prodType | null | 非必须 | |||
├─ adminName | string | 非必须 | |||
├─ isSplit | integer | 非必须 |
Path: /api/openplatform/orders/importOrders
Method: POST
接口描述:
1、orderList参数说明
(1)payMoney:支付金额
(2)userId:购买者用户id
(3)userAddressId:用户地址id,来源用户地址列表
(4)mgId:商品id
(5)gsiiId:商品的具体规格id,如果单规格,则传0
(6)quantity:购买数量
(7)postage:运费
(8)favourablePrice:优惠金额
(9)shipId:快递id,如果是已发货才需要传,否则为空
(10)shipNo:快递单号,如果是已发货才需要传,否则为空
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 | ||
orderList | 是 | 需要导入的订单数据 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | string [] | 必须 | item 类型: string | ||
├─ | 非必须 |
Path: /api/openplatform/orders/splitSendGoods
Method: POST
接口描述:
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 | ||
orderNo | 是 | 订单号 | |
godPackages | 否 | godId为小订单id, shipId:快递id,shipNo:快递单号 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | string [] | 必须 | item 类型: string | ||
├─ | 非必须 |
Path: /api/openplatform/orders/togetherSendGoods
Method: POST
接口描述:
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 | ||
shipId | 是 | 快递id,见快递列表接口 | |
shipNo | 是 | 快递单号 | |
orderNo | 是 | 订单号 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | string [] | 必须 | item 类型: string | ||
├─ | 非必须 |
Path: /api/openplatform/orders/mallOrderDetail
Method: POST
接口描述:
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 | ||
orderNo | 是 | 订单号 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | object | 必须 | |||
├─ orderNo | string | 必须 | 订单号 | ||
├─ type | integer | 必须 | 订单类型1: '普通订单', 2: '限时购', 4: '拼团', 8: '积分兑换', 16: '大转盘', 32: '支付有礼', 64: '直播抽奖', 128: '直播福利', 256: '直播邀请奖励', 512: '砍价', 1024: '礼包赠送', 2048: '预售订单' | ||
├─ payMethod | integer | 必须 | 支付方式1微信支付,2余额支付, 7 兑换码赠送, 4 线下支付, 8 好友助力 14虚拟币 100聚合支付 | ||
├─ status | integer | 必须 | 状态:0 未支付 1已支付 2发货3 收货 4完成 5已退款 6退款失败 -1失效订单(支付失败,包括超库存退款) -2取消订单 -3已关闭订单 -4删除订单 -5商家取消订单 | ||
├─ fromApp | integer | 必须 | 订单来源:'0': '公众号',,'1': '小程序', ,'2': 'PC', ,'3': 'IOS APP', ,'4': '直播小程序', ,'10': '视频号小店' | ||
├─ srgoFromInfo | string [] | 必须 | 推广方式 | item 类型: string | |
├─ | 非必须 | '10': '社群',,'51': '公开课',,'180': '直播间' | |||
├─ nickname | string | 必须 | 昵称 | ||
├─ realName | string | 必须 | 真名 | ||
├─ userId | integer | 必须 | 用户id | ||
├─ mobile | string | 必须 | 联系方式 | ||
├─ remark | string | 必须 | 订单备注 | ||
├─ userAddress | string | 必须 | 用户地址 | ||
├─ userName | string | 必须 | 收 货 人 | ||
├─ userMobile | string | 必须 | 手 机 号 | ||
string | 必须 | 邮 箱 | |||
├─ deliverType | integer | 必须 | 发货方式,1-物流配送,2-线下自提,3无需物流 | ||
├─ invoiceTitle | string | 必须 | 发票抬头 | ||
├─ invoiceMsg | string | 必须 | 发票留言 | ||
├─ invoiceCode | string | 必须 | 发票编码 | ||
├─ orderInfo | array [] | 必须 | item 类型: array | ||
├─ | 非必须 | ||||
├─ cashBackAmount | string | 非必须 | |||
├─ avatar | string | 非必须 | 头图 | ||
├─ prodName | string | 非必须 | 商品名称 | ||
├─ subSpecs | string | 非必须 | 规格 | ||
├─ quantity | integer | 非必须 | 数量 | ||
├─ deductedPoints | string | 非必须 | 积分抵扣 | ||
├─ payMoney | string | 非必须 | 支付金额 | ||
├─ favourablePrice | integer | 非必须 | 单品优惠金额 | ||
├─ deductedMoney | string | 非必须 | deductedMoney | ||
├─ useCoupon | string | 非必须 | 优惠券抵扣金额 | ||
├─ amount | string | 非必须 | 单价 | ||
├─ specificationEnabled | integer | 非必须 | 是否多规格 | ||
├─ gsiiId | integer | 非必须 | 规格ID | ||
├─ deliverStatus | integer | 非必须 | 发货状态,1-未发货,2-已发货 | ||
├─ deliverType | null | 非必须 | 发货方式,1-物流配送,3-无需物流,2-线下自提 | ||
├─ relData | string [] | 非必须 | 套餐 | item 类型: string | |
├─ | 非必须 | ||||
├─ specInfo | string [] | 非必须 | 商品规格信息 | item 类型: string | |
├─ | 非必须 | ||||
├─ mgId | string | 必须 | 商品id | ||
├─ refundStatus | string | 必须 | 售后状态1:买家申请中 2:商家同意售后, 3(已被代码重新赋值后占用),4-商家同意退货,5-买家已寄货 -1:用户撤销售后 -2:商家拒绝售后 -3:买家超时未处理 -4:商家自动关闭 -5:商家退款失败关闭 -6:退货拒绝退款 | ||
├─ payMoney | integer | 必须 | 支付金额 | ||
├─ postage | string | 必须 | 运费 | ||
├─ totalDiscountPrice | string | 必须 | 总优惠 | ||
├─ totalPrice | number | 必须 | 总价 | ||
├─ consumMoney | string | 必须 | 分成金额 | ||
├─ msg | string | 必须 | 用户留言 |
Path: /api/openplatform/orders/mallOrderPointDetails
Method: POST
接口描述:
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 | ||
orderNo | 是 | 订单号 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | object [] | 必须 | item 类型: object | ||
├─ userId | string | 非必须 | 用户id | ||
├─ nickname | string | 非必须 | 昵称 | ||
├─ headimgurl | string | 非必须 | 用户头像 | ||
├─ realName | string | 非必须 | 真名 | ||
├─ mobile | string | 非必须 | 手机号 | ||
├─ point | integer | 非必须 | 积分 | ||
├─ tag | string | 非必须 | 收益缘由 | ||
├─ ratios | string | 非必须 | 比例 | ||
├─ status | integer | 非必须 | 状态,1:已完成,2:待结算,0不分账 | ||
├─ finishAt | string | 非必须 | 收益时间 | ||
├─ orderId | string | 必须 | 订单id | ||
├─ goodName | string | 必须 | 商品名称 |
Path: /api/openplatform/orders/knowledgeOrderPointDetails
Method: POST
接口描述:
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 | ||
orderNo | 是 | 订单号 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | object [] | 必须 | item 类型: object | ||
├─ userId | string | 非必须 | 用户id | ||
├─ nickname | string | 非必须 | 昵称 | ||
├─ headimgurl | string | 非必须 | 用户头像 | ||
├─ realName | string | 非必须 | 真名 | ||
├─ mobile | string | 非必须 | 手机号 | ||
├─ point | integer | 非必须 | 积分 | ||
├─ tag | string | 非必须 | 收益缘由 | ||
├─ ratios | string | 非必须 | 比例 | ||
├─ status | integer | 非必须 | 状态,1:已完成,2:待结算,0不分账 | ||
├─ finishAt | string | 非必须 | 收益时间 | ||
├─ orderId | string | 必须 | 订单id |
Path: /api/openplatform/orders/knowledgeOrderDistribution
Method: POST
接口描述:
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 | ||
orderNo | 是 | 订单号 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | object [] | 必须 | item 类型: object | ||
├─ userId | string | 必须 | 用户id | ||
├─ nickname | string | 必须 | 昵称 | ||
├─ headimgurl | string | 必须 | 头像 | ||
├─ realName | string | 必须 | 真名 | ||
├─ mobile | string | 必须 | 手机号 | ||
├─ amount | string | 必须 | 收益金额 | ||
├─ orderNo | string | 必须 | 订单号 | ||
├─ tag | string | 必须 | 收益缘由 | ||
├─ ratios | string | 必须 | 收益比例 | ||
├─ status | integer | 必须 | 状态,1:已完成,2:待结算,0不分账 | ||
├─ createdAt | string | 必须 | 收益时间 |
Path: /api/openplatform/orders/knowledgeOrderDetail
Method: POST
接口描述:
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 | ||
orderNo | 是 | 订单号 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | object | 必须 | |||
├─ orderNo | string | 必须 | 订单号 | ||
├─ tags | string | 必须 | 订单类型 | ||
├─ status | integer | 必须 | 状态,0 未支付 1已支付-1支付失败,-2取消订单 -3 退款 -4 订单超时 -6:订单手动退款 | ||
├─ createdAt | string | 必须 | 创建时间 | ||
├─ payAt | string | 必须 | 支付时间 | ||
├─ paymentMethod | string | 必须 | 支付方式,1微信支付,2余额支付, 7 兑换码赠送, 4 线下支付, 8 好友助力 14虚拟币 100聚合支付 | ||
├─ nickname | string | 必须 | 用户昵称 | ||
├─ realName | string | 必须 | 用户真名 | ||
├─ mobile | string | 必须 | 手机号 | ||
├─ userId | string | 必须 | 用户id | ||
├─ orderInfo | object [] | 必须 | item 类型: object | ||
├─ avatar | string | 非必须 | 商品头图 | ||
├─ prodName | string | 非必须 | 商品名称 | ||
├─ prodType | string | 非必须 | 商品类型 | ||
├─ prodPrice | string | 非必须 | 商品价格 | ||
├─ quantity | integer | 非必须 | 数量 | ||
├─ deductedMoney | string | 非必须 | 优惠金额 | ||
├─ deductedPoints | string | 非必须 | 抵扣积分 | ||
├─ useCoupon | null | 非必须 | 使用的优惠券 | ||
├─ paymentMethod | string | 非必须 | 支付方式 | ||
├─ payMoney | string | 非必须 | 支付金额 | ||
├─ prodId | string | 必须 | 商品id | ||
├─ mchType | string | 必须 | 收款方式 | ||
├─ deductedCouponMoney | string | 必须 | 优惠券抵扣 | ||
├─ fromApp | integer | 必须 | 订单来源,'0': '公众号',,'1': '小程序', ,'2': 'PC', ,'3': 'IOS APP', ,'4': '直播小程序', ,'10': '视频号小店' | ||
├─ deductedMoney | string | 必须 | 积分/邀请卡抵扣 | ||
├─ discount | string | 必须 | VIP/SVIP打折 | ||
├─ srgoFromInfo | string [] | 必须 | '10': '社群',,'51': '公开课',,'180': '直播间' | item 类型: string | |
├─ | 非必须 |
Path: /api/openplatform/orders/orderList
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
page | string | 必须 | 页码 | ||
limit | string | 必须 | 每页条数, 1-100 | ||
startAt | string | 必须 | 下单起始时间 | ||
endAt | string | 必须 | 下单截止时间,起始跟截止不能超过180天 | ||
status | string | 非必须 | 订单状态:0待付款 1待发货 2已发货 3已完成 4已关闭 | ||
orderType | string | 非必须 | 订单类型:1普通订单 2拼团 4买赠 8限时购 10社群带货 51公开课带货 53直播打赏 180直播间带货,多个类型用逗号隔开 | mock: 51,180 | |
searchName | string | 非必须 | 订单号 | ||
liveVideoChoose | string | 非必须 | json字符串,某场公开课或直播间的带货,prodType: 51(直播间180) ,id: 直播ID | mock: [{"prodType":51,"id":28022},{"prodType":180,"id":2658}] |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ total | number | 非必须 | |||
├─ data | object [] | 非必须 | item 类型: object | ||
├─ liveId | number | 必须 | 直播ID,非直播带货则为0 | ||
├─ liveFromType | number | 必须 | 带货来源:51公开课 180直播间 | ||
├─ orderNo | string | 必须 | 订单号 | ||
├─ payType | number | 必须 | 支付方式:1微信支付 2余额支付 3虚拟币支付 20支付宝支付 | ||
├─ payMoney | number | 必须 | 支付金额,单位元 | ||
├─ status | number | 必须 | 订单状态:0 未支付 1已支付 2发货3 收货 4完成 5已退款 6退款失败 -1失效订单 -2取消订单 -3已关闭订单 -4已删除订单 -5商家取消订单 | ||
├─ goodsName | string | 必须 | 商品名称 | ||
├─ payAt | string | 必须 | 支付时间 | ||
├─ refundMoney | number | 必须 | 退款金额 | ||
├─ refundAt | string | 必须 | 退款时间 | ||
├─ refundStatus | number | 必须 | 退款状态:0:未退款,1:已退款,2:退款失败 | ||
├─ userId | string | 必须 | 用户ID | ||
├─ userUnionid | string | 必须 | 用户unionid | ||
├─ userNickname | string | 必须 | 用户昵称 | ||
├─ userAvatar | string | 必须 | 用户头像 | ||
├─ userMobile | string | 必须 | 用户手机 | ||
├─ createdAt | string | 必须 | 下单时间 | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/column/columnDetailList
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
page | string | 必须 | 页码 | ||
limit | string | 必须 | 条数 | ||
columnId | string | 必须 | 专栏ID | ||
searchName | string | 非必须 | 课程名称 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ total | number | 非必须 | |||
├─ data | object [] | 非必须 | item 类型: object | ||
├─ columnId | number | 必须 | 专栏ID | ||
├─ prodType | number | 必须 | 课程类型:8资料 51直播 110视频 111音频 112图文 | ||
├─ courseId | number | 必须 | 课程ID | ||
├─ courseName | string | 必须 | 课程名称 | ||
├─ pageUrl | string | 必须 | 课程链接 | ||
├─ createdAt | string | 必须 | 加入专栏时间 | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/column/columnList
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
page | string | 必须 | 页码 | ||
limit | string | 必须 | 条数 | ||
searchName | string | 非必须 | 名称 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ data | object [] | 非必须 | item 类型: object | ||
├─ columnId | number | 必须 | 专栏ID | ||
├─ name | string | 必须 | 名称 | ||
├─ intro | null | 必须 | 简介 | ||
├─ cover | string | 必须 | 封面 | ||
├─ payType | number | 必须 | 支付方式:1免费 2付费 3加密 | ||
├─ price | string | 必须 | 价格 | ||
├─ status | number | 必须 | 状态:0下架 1上架 2定时上架 | ||
├─ clicks | number | 必须 | 访问量 | ||
├─ createdAt | string | 必须 | 创建时间 | ||
├─ updatedAt | string,null | 必须 | 更新时间 | ||
├─ total | number | 非必须 | |||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/combo/comboList
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
page | string | 必须 | 页码 | ||
limit | string | 必须 | 条数 | ||
searchName | string | 非必须 | 名称 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ data | object [] | 非必须 | item 类型: object | ||
├─ cId | number | 必须 | 套餐ID | ||
├─ name | string | 必须 | 名称 | ||
├─ desc | null,string | 必须 | 简介 | ||
├─ cover | string | 必须 | 封面 | ||
├─ payType | number | 必须 | 支付方式:1免费 2付费 3加密 | ||
├─ price | string | 必须 | 价格 | ||
├─ status | number | 必须 | 状态:1上架 2下架 3定时上架 | ||
├─ visits | number | 必须 | 访问数 | ||
├─ createdAt | string | 必须 | 创建时间 | ||
├─ updatedAt | null,string | 必须 | 更新时间 | ||
├─ total | number | 非必须 | |||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/combo/comboDetailList
Method: POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
page | string | 必须 | |||
limit | string | 必须 | |||
cId | string | 必须 | 知识套餐ID | ||
prodType | string | 非必须 | 课程类型:8资料 9专栏 10社群 11测评 51公开课 75互动测评 77AI.测评 110视频 111音频 112图文 125考试 142电子书 180直播间 181圈子 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | number | 非必须 | |||
data | object | 非必须 | |||
├─ total | number | 非必须 | |||
├─ data | object [] | 非必须 | item 类型: object | ||
├─ cId | number | 必须 | 知识套餐ID | ||
├─ prodType | number | 必须 | 课程类型:8资料 9专栏 10社群 11测评 51公开课 75互动测评 77AI.测评 110视频 111音频 112图文 125考试 142电子书 180直播间 181圈子 | ||
├─ courseId | number | 必须 | 课程ID | ||
├─ courseName | string | 必须 | 课程名称 | ||
├─ pageUrl | string | 必须 | 课程链接 | ||
├─ createdAt | string | 必须 | 加入时间 | ||
ext | object | 非必须 | |||
├─ s | string | 非必须 |
Path: /api/openplatform/goods/goodsForm
Method: POST
接口描述:
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 | ||
mgId | 是 | 商品Id |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | object [] | 必须 | item 类型: object | ||
├─ id | integer | 非必须 | 表单id | ||
├─ name | string | 非必须 | 表单名称 | ||
├─ status | integer | 非必须 | |||
├─ collectPage | integer | 非必须 |
Path: /api/openplatform/goods/categoryList
Method: POST
接口描述:
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 | ||
categoryName | 否 | 分类名称 | |
limit | 否 | ||
page | 否 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | object | 必须 | |||
├─ data | object [] | 必须 | item 类型: object | ||
├─ gcId | integer | 必须 | 分类id | ||
├─ name | string | 必须 | 分类名称 | ||
├─ parentId | integer | 必须 | 分类id | ||
├─ sort | integer | 必须 | 排序 | ||
├─ avatar | string | 必须 | 分类图片 | ||
├─ isTopLayer | integer | 必须 | 是否置顶,1:是,0否 | ||
├─ children | object [] | 必须 | 子分类 | item 类型: object | |
├─ gcId | integer | 必须 | |||
├─ name | string | 必须 | |||
├─ parentId | integer | 必须 | |||
├─ sort | integer | 必须 | |||
├─ avatar | string,null | 必须 | |||
├─ isTopLayer | integer | 必须 | |||
├─ total | integer | 必须 |
Path: /api/openplatform/goods/goodsList
Method: POST
接口描述:
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 | ||
limit | 否 | 每页条数,默认10 | |
page | 否 | 第几页,默认为1 | |
goodsName | 否 | 商品名称 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | object | 必须 | |||
├─ data | object [] | 必须 | item 类型: object | ||
├─ mgId | integer | 必须 | 商品id | ||
├─ name | string | 必须 | 商品名称 | ||
├─ avatar | string | 必须 | 商品头图 | ||
├─ stock | integer | 必须 | 库存 | ||
├─ sales | integer | 必须 | 销量 | ||
├─ createdAt | string | 必须 | 创建时间 | ||
├─ specificationEnabled | integer | 必须 | 是否多规格 | ||
├─ price | string | 必须 | 价格 | ||
├─ status | integer | 必须 | 状态 -1:下架 1:上架 | ||
├─ total | integer | 必须 | 总条数 |
Path: /api/openplatform/goods/goodsInfo
Method: POST
接口描述:
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 | ||
mgId | 是 | 商品Id |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | object | 必须 | |||
├─ name | string | 必须 | 商品名称 | ||
├─ shareDesc | string | 必须 | 商品描述 | ||
├─ categories | string | 必须 | 分类 | ||
├─ avatar | string | 必须 | 头图 | ||
├─ videoAvatar | string | 必须 | 视频封面 | ||
├─ videoId | null | 必须 | 视频id | ||
├─ detailInfo | string [] | 必须 | 商品详情 | item 类型: string | |
├─ | 非必须 | ||||
├─ price | string | 必须 | 价格 | ||
├─ originalPrice | string | 必须 | 原价(划线价) | ||
├─ stock | integer | 必须 | 库存 | ||
├─ initSales | integer | 必须 | 虚拟销量 | ||
├─ sales | integer | 必须 | 实际销量 | ||
├─ pointsDeduct | string | 必须 | 积分抵扣 | ||
├─ vipDiscount | integer | 必须 | vip折扣 | ||
├─ svipDiscount | integer | 必须 | svip折扣 | ||
├─ cooDiscount | string | 必须 | 代理折扣 | ||
├─ agencyDiscount | string | 必须 | 代理折扣 | ||
├─ agent6Discount | string | 必须 | 代理折扣 | ||
├─ agent7Discount | string | 必须 | 代理折扣 | ||
├─ agent8Discount | string | 必须 | 代理折扣 | ||
├─ agent9Discount | string | 必须 | 代理折扣 | ||
├─ isMallExpressDeliver | integer | 必须 | 是否物流配送 1开启,-1关闭 | ||
├─ isMallOfflineDeliver | integer | 必须 | 是否线下自提 1开启,-1关闭 | ||
├─ postage | string | 必须 | 运费 | ||
├─ freightMode | integer | 必须 | 运费模式: 0-统一运费 1-运费模板 | ||
├─ freightTempId | integer | 必须 | 运费模板ID | ||
├─ freightTempName | null | 必须 | 运费模板名 | ||
├─ isRelatedProd | integer | 必须 | 是否支持关联商品售卖,0-否,1-是 | ||
├─ minOrderQuantity | integer | 必须 | 起售数量 | ||
├─ limitNumber | integer | 必须 | 限购数量 | ||
├─ limitType | integer | 必须 | 限制类型,1-终身限购,2-按周期限购 | ||
├─ limitCycleType | integer | 必须 | 周期限制类型,1-每天,2-每周,3-每月,4-每季度,5-每半年,6-每年 | ||
├─ isLimitAssignUser | integer | 必须 | 是否限制指定用户购买 1开启,-1关闭 | ||
├─ status | integer | 必须 | 状态 -1:下架 1:上架 | ||
├─ givenPoints | integer | 必须 | 赠送的积分 | ||
├─ specItemInfos | object [] | 必须 | 规格信息 | item 类型: object | |
├─ gsiiId | integer | 必须 | 规格id | ||
├─ mgId | integer | 必须 | 商品id | ||
├─ originalPrice | string | 必须 | 原价 | ||
├─ price | string | 必须 | 售价 | ||
├─ flashPrice | string | 必须 | 限时折扣价格 | ||
├─ stock | integer | 必须 | 库存 | ||
├─ weight | string | 必须 | 重量 | ||
├─ reducePrice | string | 必须 | 减价 | ||
├─ discount | string | 必须 | 折扣 | ||
├─ gsiPicture | null | 必须 | 规格图片 | ||
├─ sales | string | 必须 | 销量 | ||
├─ attributes | object [] | 必须 | 属性 | item 类型: object | |
├─ k | string | 非必须 | 属性名 | ||
├─ v | string | 非必须 | 属性值 | ||
├─ goodsArr | object [] | 必须 | 关联商城商品 | item 类型: object | |
├─ id | integer | 非必须 | |||
├─ name | string | 非必须 | |||
├─ provinceName | string | 必须 | 发货地址省份 | ||
├─ cityName | string | 必须 | 发货地址市/区 | ||
├─ specificationEnabled | string | 必须 | 商品型号,0统一型号,1多规格 | ||
├─ agentDiscount | string | 必须 | 初级代理商折扣 | ||
├─ partnerDiscount | string | 必须 | 中级代理商折扣 | ||
├─ branchDiscount | string | 必须 | 高级代理商折扣 |
Path: /api/openplatform/goods/goodsSku
Method: POST
接口描述:
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 | ||
mgId | 是 | 商品id |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | object [] | 必须 | item 类型: object | ||
├─ gsiiId | integer | 必须 | 规格id | ||
├─ mgId | integer | 必须 | 商品id | ||
├─ itemGroup | string | 必须 | 规格组合 | ||
├─ originalPrice | string | 必须 | 原价 | ||
├─ price | string | 必须 | 售价 | ||
├─ flashPrice | string | 必须 | 限时折扣价 | ||
├─ stock | integer | 必须 | 库存 | ||
├─ weight | string | 必须 | 重量 | ||
├─ reducePrice | string | 必须 | 减价 | ||
├─ discount | string | 必须 | 折扣 | ||
├─ gsiPicture | string | 必须 | 规格图片 | ||
├─ sales | string | 必须 | 销量 |
Path: /api/openplatform/goods/goodsTagList
Method: POST
接口描述:
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 | ||
page | 否 | ||
limit | 否 | ||
tagName | 否 | 标签名称 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | object | 必须 | |||
├─ data | object [] | 必须 | item 类型: object | ||
├─ gtId | integer | 必须 | 标签id | ||
├─ name | string | 必须 | 标签名 | ||
├─ tagsDesc | string | 必须 | 标签说明 | ||
├─ sort | integer | 必须 | 排序 | ||
├─ total | integer | 必须 | 总条数 |
Path: /api/openplatform/goods/goodsCommentsList
Method: POST
接口描述:
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 | ||
limit | 否 | 每页条数,默认10 | |
page | 是 | 第几页 | |
startTime | 否 | 评价开始时间 | |
endTime | 否 | 结束时间 | |
orderNo | 否 | 订单号 | |
goodsName | 否 | 商品名称 | |
starRank | 否 | 评价星级,1,2,3,4,5 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | object | 必须 | |||
├─ data | object [] | 必须 | item 类型: object | ||
├─ orderNo | string | 必须 | 订单号 | ||
├─ starRank | integer | 必须 | 评价星级 | ||
├─ words | string,null | 必须 | 评价内容 | ||
├─ pictures | string,null | 必须 | 评论图片 | ||
├─ type | integer | 必须 | 评论类型1置顶评价2有图有评语3仅有图4仅有评语5无图无评语6系统默认评价 | ||
├─ isAcquiesceComment | integer | 必须 | 是否系统默认好评1是0否 | ||
├─ createdAt | string | 必须 | 创建时间 | ||
├─ goId | integer | 必须 | 订单id | ||
├─ mgId | integer | 必须 | 商品id | ||
├─ nickname | string | 必须 | 用户昵称 | ||
├─ name | string | 必须 | 商品名称 | ||
├─ subSpecs | string | 必须 | 规格 | ||
├─ gsiiId | integer,null | 必须 | 规格id | ||
├─ mceId | null | 必须 | |||
├─ extraWords | null | 必须 | 追加评论 | ||
├─ extraPictures | null | 必须 | 追加评论图片 | ||
├─ extraStatus | null | 必须 | 状态,1正常-1删除 | ||
├─ extraAt | null | 必须 | 评论时间 | ||
├─ userId | string | 必须 | 用户id | ||
├─ total | integer | 必须 | 总条数 |
Path: /api/openplatform/goods/importGoods
Method: POST
接口描述:
1、importGoods数据说明
[
{
"minOrderQuantity": 1, //商品起售数量
"name": "0816商品daoru", //商品名称
"banner": [//商品主图,二维数组
{
"url": "https://knowledge-payment.oss-cn-beijing.aliyuncs.com/lj7l/resource/imgs/3223e7ca/admin-fe_lj7l_uploadBox_xjECktFcSGWEBtjDkh7i.jpg",//URL图片链接
"sort": 0 //主图顺序
},
{
"url": "https://knowledge-payment.oss-cn-beijing.aliyuncs.com/lj7l/resource/imgs/3223e7ca/admin-fe_lj7l_uploadBox_JBmFBAyeAxD3Sk73zWHy.jpg",
"sort": 1
}
],
"price": "20",//商品价格,如果是多规格为最低价格
"stock": 400, //库存,多规格为所有规格库存总和
"catOne": 10162,//商品一分类id,具体值见分类接口
"catTwo": 10386,//商品二级分类id
"specificationEnabled": true,//是否多规格,单规格值为false
"specs": [ //规格列表,单规格传空数组
{
"gsId": null,
"mgId": null,
"name": "规格1"//规格名称
},
{
"gsId": null,
"mgId": null,
"name": "规格2"
}
],
"specItems": [//规格属性列表,单规格传空数组
{
"gsiId": null,
"mgId": null,
"gsId": null,
"name": "规格值11",//属性名称
"index": 0,//属于第几个规格的属性,从0开始
"gsiPicture": ""
},
{
"gsiId": null,
"mgId": null,
"gsId": null,
"name": "规格值21",
"index": 1,
"gsiPicture": ""
},
{
"gsiId": null,
"mgId": null,
"gsId": null,
"name": "规格值22",
"index": 1,
"gsiPicture": ""
},
{
"gsiId": null,
"mgId": null,
"gsId": null,
"name": "规格值12",
"index": 0,
"gsiPicture": ""
}
],
"specItemInfos": [//商品规格信息,单规格传空数组
{
"gsiiId": null,
"mgId": null,
"itemGroup": [
"规格值11",
"规格值21"
],
"stock": "100",//库存
"weight": null,
"originalPrice": "",//原价
"price": "50",//现价
"gsiPicture": "",
"sales": 0
},
{
"gsiiId": null,
"mgId": null,
"itemGroup": [
"规格值11",
"规格值22"
],
"stock": "100",
"weight": null,
"originalPrice": "",
"price": "20",
"gsiPicture": "",
"sales": 0
},
{
"gsiiId": null,
"mgId": null,
"itemGroup": [
"规格值12",
"规格值21"
],
"stock": "100",
"weight": null,
"originalPrice": "",
"price": "30",
"gsiPicture": "",
"sales": 0
},
{
"gsiiId": null,
"mgId": null,
"itemGroup": [
"规格值12",
"规格值22"
],
"stock": "100",
"weight": null,
"originalPrice": "",
"price": "60",
"gsiPicture": "",
"sales": 0
}
]
}
]
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 |
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 | ||
importGoods | 是 | 要导入的商品数据 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
非必须 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|
Path: /api/openplatform/goods/goodsGuide
Method: POST
接口描述:
Query
参数名称 | 是否必须 | 示例 | 备注 |
---|---|---|---|
timestamp | 是 | ||
appid | 是 | ||
hc | 是 | ||
sign | 是 | ||
mgId | 是 | 商品Id |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
statusCode | integer | 必须 | |||
data | object | 必须 | |||
├─ isOpenGuide | integer | 必须 | 是否开启引入入群 1开启 0关闭 | ||
├─ guideType | integer [] | 必须 | item 类型: integer | ||
├─ | 非必须 | 1:详情页引导进群 2:购买成功页引导进群 | |||
├─ guideDesc | string | 必须 | 引导描述 | ||
├─ guideQrcode | string | 必须 | 二维码 | ||
├─ guideTitle | string | 必须 | 二维码标题 | ||
├─ guideTypeReal | integer | 必须 |
接口描述:
{
"signature": "517f8a4caf065e5ac8bc8df85c84665ac6d581cd",
"timestamp": 1693367259,
"goods": {
"mgId": 123,//商品id
"price": "12.00",//商品价格
"originalPrice": "50.00",//原价
"cost": 1,//成本价
"stock": 94,//库存
"specificationEnabled": 1//是否开启多规格 1开启 0单一规格
},
"sku": [ //商品规格信息
{
"gsiiId": 9607,//规格id
"mgId": 53223,//商品id
"itemGroup": [//具体规格
"13*19",
"生字本"
],
"originalPrice": "50.00",//原价
"price": "13.00",//商品价格
"flashPrice": "0.00",//限时折扣价格
"stock": 60,//库存
"weight": "0.00",//商品规格重量(单位kg)
"reducePrice": "0.00",//减价
"discount": "0.00",//折扣
"gsiPicture": null,
"sales": "41"//销量
},
{
"gsiiId": 9608,
"mgId": 53223,
"itemGroup": [
"13*19",
"田字格"
],
"originalPrice": "50.00",
"price": "12.00",
"flashPrice": "0.00",
"stock": 94,
"weight": "0.00",
"reducePrice": "0.00",
"discount": "0.00",
"gsiPicture": null,
"sales": "5"
}
]
}
接口描述:
{
"signature": "c661ea29bb74cc8b06117fd01a4c825a76a9698d",
"timestamp": 1693380854,
"order": {
"orderNo": "202308301534113k3ovvkv51975299",//订单号
"status": 1,//状态 0 未支付 1已支付 2发货3 收货 4完成 5已退款 6退款失败 -1失效订单(支付失败,包括超库存退款) -2取消订单 -3已关闭订单 -4删除订单 -5商家取消订单
"deliverType": 1 //发货方式,1-物流配送,2-线下自提,3无需物流
},
"orderDatail": {//订单明细
"godId": 373156,//小订单id
"mgId": 53938, //商品id
"goodsName": "8.30链动商品",//goodsName
"subSpecs": "",//规格
"deliverStatus": 1,//发货状态,1-未发货,2-已发货
"deliverType": null,//发货方式,1-物流配送,3-无需物流,2-线下自提
"deliverAt": null,//发货时间
"isRefund": 0,//是否售后完成,0:否 1:是
"refundType": 1,//1 原款退还,2 自定义金额退款,3 取消购买
"refundMoney": 1,//退款金额
"refundStatus": 1,//售后操作,1:买家申请中 2:商家同意售后, 3(已被代码重新赋值后占用),4-商家同意退货,5-买家已寄货 -1:用户撤销售后 -2:商家拒绝售后 -3:买家超时未处理 -4:商家自动关闭 -5:商家退款失败关闭 -6:退货拒绝退款
"afterStatus": 1,//售后状态,1:售后中 2:售后完成 -1:售后关闭
"applyAt": null,//买家申请时间
"afterSaleAt": null,//商家同意或拒绝售后时间
"finishAt": null//售后完成时间
},
}